Skip to content

Commit

Permalink
FIX docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pubkey committed Mar 10, 2024
1 parent d40011c commit cce2633
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs-src/docs/rx-local-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ slug: rx-local-document.html
Local documents are a special class of documents which are used to store local metadata.
They come in handy when you want to store settings or additional data next to your documents.

- Local Documents can exist on `RxDatabase` or `RxCollection`.
- Local Documents can exist on a [RxDatabase](./rx-database.md) or [RxCollection](./rx-collection.md).
- Local Document do not have to match the collections schema.
- Local Documents do not get replicated.
- Local Documents will not be found on queries.
- Local Documents can not have attachments.
- Local Documents will not get handled by the [migration-schema](./migration-schema.md).
- The id of a local document has the `maxLength` of `128` characters.

:::note
While local documents can be very usefull, in many cases the [RxState](./rx-state.md) API is more convenient.

Check failure on line 20 in docs-src/docs/rx-local-document.md

View workflow job for this annotation

GitHub Actions / test-code-style

usefull ==> useful
:::

## Add the local documents plugin

Expand Down
4 changes: 2 additions & 2 deletions docs-src/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ const sidebars = {
'migration-storage'
],
},
'rx-state',
'reactivity',
'rx-state',
'rx-local-document',
'encryption',
'key-compression',
'rx-local-document',
'leader-election',
'cleanup',
'backup',
Expand Down

0 comments on commit cce2633

Please sign in to comment.