From 231d39884b7d09cfe2707151fa5e9886ad027970 Mon Sep 17 00:00:00 2001 From: Max Nowack Date: Mon, 6 Jan 2025 09:33:26 +0100 Subject: [PATCH] docs: add missing doc heads --- docs/.vitepress/config.mts | 1 + .../core/autofetchcollection/index.md | 24 +++++++++++++++++++ docs/reference/core/collection/index.md | 24 +++++++++++++++++++ .../core/combinepersistenceadapters/index.md | 24 +++++++++++++++++++ docs/reference/core/createindex/index.md | 24 +++++++++++++++++++ .../core/createindexprovider/index.md | 24 +++++++++++++++++++ .../core/creatememoryadapter/index.md | 24 +++++++++++++++++++ docs/reference/core/index.md | 0 docs/reference/index.md | 24 +++++++++++++++++++ 9 files changed, 169 insertions(+) delete mode 100644 docs/reference/core/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 9c3e0166..035eb00b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -269,6 +269,7 @@ export default withMermaid({ '/reactivity/usignal/index.html': '/reference/usignal/', '/reactivity/vue.html': '/reference/vue/', '/reactivity/vue/index.html': '/reference/vue/', + '/reference/core/index.html': '/reference/', '/replication.html': '/sync/', '/replication/appwrite/index.html': '/sync/', '/replication/firebase/index.html': '/sync/', diff --git a/docs/reference/core/autofetchcollection/index.md b/docs/reference/core/autofetchcollection/index.md index e79c2cd0..3f970249 100644 --- a/docs/reference/core/autofetchcollection/index.md +++ b/docs/reference/core/autofetchcollection/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/autofetchcollection/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/autofetchcollection/ +- - meta + - name: og:title + content: AutoFetchCollection | SignalDB +- - meta + - name: og:description + content: Learn about the AutoFetchCollection in SignalDB, enabling reactive and on-demand data fetching with customizable options like purge delay and persistence adapters. +- - meta + - name: description + content: Learn about the AutoFetchCollection in SignalDB, enabling reactive and on-demand data fetching with customizable options like purge delay and persistence adapters. +- - meta + - name: keywords + content: SignalDB, AutoFetchCollection, reactive data fetching, query-based fetching, data persistence, JavaScript, TypeScript, local-first database, loading state management, on-demand data loading, persistence adapters +--- # AutoFetchCollection ```ts diff --git a/docs/reference/core/collection/index.md b/docs/reference/core/collection/index.md index 352f51e6..01fe8e96 100644 --- a/docs/reference/core/collection/index.md +++ b/docs/reference/core/collection/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/collection/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/collection/ +- - meta + - name: og:title + content: Collection | SignalDB +- - meta + - name: og:description + content: Learn about the SignalDB Collection class, a flexible and reactive way to manage and manipulate schemaless data with support for persistence adapters and transformations. +- - meta + - name: description + content: Learn about the SignalDB Collection class, a flexible and reactive way to manage and manipulate schemaless data with support for persistence adapters and transformations. +- - meta + - name: keywords + content: SignalDB, Collection, data management, reactive collections, persistence adapters, TypeScript, JavaScript, schemaless data, field-level reactivity, batch operations +--- # Collection ```ts diff --git a/docs/reference/core/combinepersistenceadapters/index.md b/docs/reference/core/combinepersistenceadapters/index.md index bd92149b..551155b9 100644 --- a/docs/reference/core/combinepersistenceadapters/index.md +++ b/docs/reference/core/combinepersistenceadapters/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/combinepersistenceadapters/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/combinepersistenceadapters/ +- - meta + - name: og:title + content: combinePersistenceAdapters | SignalDB +- - meta + - name: og:description + content: Learn how to use combinePersistenceAdapters in SignalDB to merge multiple persistence adapters for enhanced flexibility and performance. +- - meta + - name: description + content: Learn how to use combinePersistenceAdapters in SignalDB to merge multiple persistence adapters for enhanced flexibility and performance. +- - meta + - name: keywords + content: SignalDB, combinePersistenceAdapters, persistence adapters, data management, primary adapter, secondary adapter, TypeScript, JavaScript, data storage +--- # combinePersistenceAdapters ```ts diff --git a/docs/reference/core/createindex/index.md b/docs/reference/core/createindex/index.md index 555b2ee0..ac37a908 100644 --- a/docs/reference/core/createindex/index.md +++ b/docs/reference/core/createindex/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/createindex/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/createindex/ +- - meta + - name: og:title + content: createIndex | SignalDB +- - meta + - name: og:description + content: Learn how to use the createIndex function in SignalDB to add single-field indices to collections for faster query performance. +- - meta + - name: description + content: Learn how to use the createIndex function in SignalDB to add single-field indices to collections for faster query performance. +- - meta + - name: keywords + content: SignalDB, createIndex, collection indices, single-field index, performance optimization, data management, TypeScript, JavaScript, indexing, query optimization +--- # createIndex ```ts diff --git a/docs/reference/core/createindexprovider/index.md b/docs/reference/core/createindexprovider/index.md index 0e344e7d..c2cc350e 100644 --- a/docs/reference/core/createindexprovider/index.md +++ b/docs/reference/core/createindexprovider/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/createindexprovider/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/createindexprovider/ +- - meta + - name: og:title + content: createIndexProvider | SignalDB +- - meta + - name: og:description + content: Discover how to use the createIndexProvider function in SignalDB to build custom index providers for advanced query optimizations in collections. +- - meta + - name: description + content: Discover how to use the createIndexProvider function in SignalDB to build custom index providers for advanced query optimizations in collections. +- - meta + - name: keywords + content: SignalDB, createIndexProvider, custom index providers, query optimization, collection indices, data management, TypeScript, JavaScript, performance enhancement, advanced indexing +--- # createIndexProvider ```ts diff --git a/docs/reference/core/creatememoryadapter/index.md b/docs/reference/core/creatememoryadapter/index.md index 75db76d3..8a3ca406 100644 --- a/docs/reference/core/creatememoryadapter/index.md +++ b/docs/reference/core/creatememoryadapter/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/core/creatememoryadapter/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/core/creatememoryadapter/ +- - meta + - name: og:title + content: createMemoryAdapter | SignalDB +- - meta + - name: og:description + content: Learn how to use createMemoryAdapter in SignalDB to implement custom memory-based data storage for collections with array-like methods. +- - meta + - name: description + content: Learn how to use createMemoryAdapter in SignalDB to implement custom memory-based data storage for collections with array-like methods. +- - meta + - name: keywords + content: SignalDB, createMemoryAdapter, memory adapter, data storage, custom adapters, JavaScript, TypeScript, in-memory collections, collection management, array methods +--- # createMemoryAdapter ```js diff --git a/docs/reference/core/index.md b/docs/reference/core/index.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/reference/index.md b/docs/reference/index.md index 3498095f..efe242ad 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,3 +1,27 @@ +--- +head: +- - link + - rel: canonical + href: https://signaldb.js.org/reference/ +- - meta + - name: og:type + content: article +- - meta + - name: og:url + content: https://signaldb.js.org/reference/ +- - meta + - name: og:title + content: Reference | SignalDB +- - meta + - name: og:description + content: Explore the comprehensive reference for SignalDB, including core components, integrations, persistence adapters, and reactivity adapters to enhance your projects. +- - meta + - name: description + content: Explore the comprehensive reference for SignalDB, including core components, integrations, persistence adapters, and reactivity adapters to enhance your projects. +- - meta + - name: keywords + content: SignalDB, API reference, core components, integrations, persistence adapters, reactivity adapters, data management, JavaScript, TypeScript, SyncManager, collections, reactivity +--- # Reference SignalDB consists of several packages of which each has indiviudal exports.