From cce263361b5e52ea407582fa9bc48c0f228e8181 Mon Sep 17 00:00:00 2001 From: pubkey <8926560+pubkey@users.noreply.github.com> Date: Sun, 10 Mar 2024 14:48:00 +0100 Subject: [PATCH] FIX docs --- docs-src/docs/rx-local-document.md | 5 ++++- docs-src/sidebars.js | 4 ++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs-src/docs/rx-local-document.md b/docs-src/docs/rx-local-document.md index 7ea102061d7..eef7d730b83 100644 --- a/docs-src/docs/rx-local-document.md +++ b/docs-src/docs/rx-local-document.md @@ -8,7 +8,7 @@ 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. @@ -16,6 +16,9 @@ They come in handy when you want to store settings or additional data next to yo - 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. +::: ## Add the local documents plugin diff --git a/docs-src/sidebars.js b/docs-src/sidebars.js index 39bdc860528..408cb764e61 100644 --- a/docs-src/sidebars.js +++ b/docs-src/sidebars.js @@ -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',