Skip to content

Commit 34ceed8

Browse files
committed
docs: fix links and typos, remove dead links
1 parent adc7c96 commit 34ceed8

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ const client = new ApolloClient({
6262
});
6363
```
6464

65-
See a complete example in the [React Native example](./examples/react-native/App.tsx).
66-
6765
#### Web
6866

6967
```js
@@ -86,7 +84,7 @@ const client = new ApolloClient({
8684
});
8785
```
8886

89-
See a complete example in the [web example](./examples/web/src/index.tsx).
87+
See a complete example in the [web example](./examples/web/src/App.tsx).
9088

9189
## Contributing
9290

docs/advanced-usage.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,6 @@ const persistor = new CachePersistor({
104104
})
105105
```
106106
107-
Take a look at the [examples](../examples/react-native/src/utils/persistence/persistenceMapper.ts)
108-
and [it's corresponding documentation](../examples/react-native/src/utils/persistence/README.md)
109-
110107
## Custom Triggers
111108
112109
For control over persistence timing, provide a function to the `trigger` option.

docs/faq.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ of the 'write' trigger on web, we've omitted a 'background' trigger on web.
3030
resolve once the cache has been restored, which you can await before rendering
3131
your app.
3232

33-
This library, like Apollo Client, is framework agnostic; however, since many
33+
This library, like Apollo Client, is framework-agnostic; however, since many
3434
people have asked, here's an example of how to handle this in React. PRs with
3535
examples from other frameworks are welcome.
3636

37-
You can find all examples in the [examples](./examples/) directory.
37+
You can find all examples in the [examples](./../examples) directory.
3838

3939
## React Using Hooks
4040

@@ -110,8 +110,7 @@ details.
110110
Other alternatives have been recommended in
111111
[#2](https://github.com/apollographql/apollo3-cache-persist/issues/2#issuecomment-350823835),
112112
including using logic in your UI to filter potentially-outdated information.
113-
Furthermore, the [`maxSize` option](#additional-options) and
114-
[methods on `CachePersistor`](#using-cachepersistor) provide facilities to
113+
Furthermore, the `maxSize` option and methods on `CachePersistor` provide facilities to
115114
manage the growth of the cache.
116115

117116
For total control over the cache contents, you can setup a background task to
@@ -126,11 +125,11 @@ benefit of ensuring the cache is loaded with fresh data when your app launches.
126125

127126
For the same reasons given in the preceding answer, it's not possible to migrate
128127
or transform your persisted cache data. However, by using the
129-
[methods on `CachePersistor`](#using-cachepersistor), it's simple to reset the
128+
methods on `CachePersistor`, it's simple to reset the
130129
cache upon changes to the schema.
131130

132131
Simply instantiate a `CachePersistor` and only call `restore()` if the app's
133-
schema hasn't change. (You'll need to track your schema version yourself.)
132+
schema hasn't changed. (You'll need to track your schema version yourself.)
134133

135134
Here's an example of how this could look:
136135

0 commit comments

Comments
 (0)