Skip to content

Commit 59ca8dd

Browse files
authored
Tweak docs (#240)
1 parent 436e908 commit 59ca8dd

File tree

5 files changed

+46
-11
lines changed

5 files changed

+46
-11
lines changed

Writerside/cfg/buildprofiles.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@
1111
<download-title>GitHub</download-title>
1212
<download-page>https://github.com/apollographql/apollo-kotlin-normalized-cache/</download-page>
1313
<showDownloadButton>true</showDownloadButton>
14-
<enable-browser-edits>true</enable-browser-edits>
15-
<browser-edits-url>https://github.com/apollographql/apollo-kotlin-normalized-cache/edit/main/Writerside/
16-
</browser-edits-url>
14+
<enable-contribution>false</enable-contribution>
1715
<custom-css>custom.css</custom-css>
16+
<primary-color>#fc5200</primary-color>
1817
</variables>
1918
</build-profile>
2019
</buildprofiles>

Writerside/cfg/static/custom.css

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
.link {
22
border-color: inherit;
33
}
4+
5+
:root.theme-dark {
6+
--wh-color-white: rgb(207 215 214);
7+
--wh-color-bg-main: #13222a;
8+
--wh-color-bg-main-dark: rgb(13 23 28);
9+
--wh-color-accent-substrate-bg: #13222a;
10+
--wh-color-border-default: rgb(37 66 80);
11+
}
12+
13+
.app__footer {
14+
display: none !important;
15+
}
16+
17+
.app__header {
18+
border-bottom: 1px solid;
19+
border-bottom-color: var(--wh-color-border-default);
20+
}
21+
22+
.sub-title__edit-info {
23+
color: rgb(207 215 214 / 35%);
24+
25+
}

Writerside/doc.tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<instance-profile
55
id="doc"
6-
name="apollo-kotlin-normalized-cache"
6+
name="Apollo Kotlin Normalized Cache"
77
start-page="welcome.md"
88
>
99

Writerside/topics/migration-guide.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
The Normalized Cache is now hosted in this dedicated repository and published at its own cadence and versioning scheme.
44

55
The Normalized Cache in the [Apollo Kotlin main repository](https://github.com/apollographql/apollo-kotlin) will not receive new features - they
6-
are added here instead. In the future, the main repository Normalized Cache will be deprecated and then removed.
6+
are added here instead. In the future, the main repository version will be deprecated and then removed.
77

88
This guide highlights the main differences between this library and the main repository version, and how to migrate from it.
99

1010
## Artifacts and packages
1111

12-
To use this library, update the dependencies to your project:
12+
The Normalized Cache requires Apollo Kotlin ***v4.3.0*** or later.
13+
14+
First, update the dependencies to your project:
1315

1416
```kotlin
1517
// build.gradle.kts
@@ -47,7 +49,7 @@ Configure the [compiler plugin](compiler-plugin.md) in your `build.gradle.kts` f
4749
```kotlin
4850
apollo {
4951
service("service") {
50-
packageName.set("com.example")
52+
// ...
5153

5254
// Add this
5355
plugin("com.apollographql.cache:normalized-cache-apollo-compiler-plugin:%latest_version%") {
@@ -61,7 +63,7 @@ apollo {
6163
// For Apollo Kotlin v5 and later
6264
apollo {
6365
service("service") {
64-
packageName.set("com.example")
66+
// ...
6567

6668
// Add this
6769
plugin("com.apollographql.cache:normalized-cache-apollo-compiler-plugin:%latest_version%")

Writerside/topics/welcome.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Compared to the previous version, this library brings:
1717
- SQL cache improved performance
1818

1919
The Normalized Cache in the [Apollo Kotlin main repository](https://github.com/apollographql/apollo-kotlin) will not receive new features - they
20-
are added here instead. In the future, the main repository Normalized Cache will be deprecated and then removed.
20+
are added here instead. In the future, the main repository version will be deprecated and then removed.
2121

2222
## Use in your project
2323

@@ -26,7 +26,7 @@ are added here instead. In the future, the main repository Normalized Cache will
2626
2727
{style="warning"}
2828

29-
The Normalized Cache requires Apollo Kotlin v4.3.0 or later.
29+
The Normalized Cache requires Apollo Kotlin ***v4.3.0*** or later.
3030

3131
1. Add the dependencies to your project
3232

@@ -56,5 +56,17 @@ apollo {
5656
}
5757
}
5858
```
59+
<code-block lang="kotlin" collapsible="true" collapsed-title="For Apollo Kotlin v5+">
60+
// For Apollo Kotlin v5 and later
61+
apollo {
62+
service("service") {
63+
// ...
64+
65+
// Add this
66+
plugin("com.apollographql.cache:normalized-cache-apollo-compiler-plugin:%latest_version%")
67+
pluginArgument("com.apollographql.cache.packageName", packageName.get())
68+
}
69+
}
70+
</code-block>
5971

60-
If you're already using the main repository Normalized Cache, please consult the [migration guide](migration-guide.md).
72+
If you're already using the main repository version, please consult the [migration guide](migration-guide.md).

0 commit comments

Comments
 (0)