From 05e86d3df1a2a01b49d4dc492506755ba01ccd24 Mon Sep 17 00:00:00 2001 From: Trezy Date: Fri, 24 Apr 2026 09:28:29 -0500 Subject: [PATCH] chore: reorganize docs files into correct directories --- .../production-deployment.md | 0 .../docs/docs/guides/{ => admin}/api-keys.md | 0 .../docs/guides/{ => admin}/event-logs.md | 0 .../docs/guides/{ => admin}/permissions.md | 0 .../guides/{ => database}/database-setup.md | 0 .../postgres-to-sqlite-migration.md | 0 .../sqlite-to-postgres-migration.md | 0 .../docs/guides/{ => features}/api-clients.md | 0 .../{ => features}/developing-plugins.md | 0 .../docs/guides/{ => features}/labelers.md | 0 .../docs/guides/{ => features}/plugins.md | 0 .../docs/guides/{ => indexing}/backfill.md | 0 .../docs/guides/{ => indexing}/index-hooks.md | 0 .../docs/guides/{ => indexing}/lexicons.md | 0 .../scripting}/algolia-sync.md | 0 .../scripting}/batch-save.md | 0 .../scripting}/cascading-delete.md | 0 .../scripting}/complex-mutations.md | 0 .../scripting}/create-record.md | 0 .../scripting}/expanded-query.md | 0 .../scripting}/get-record.md | 0 .../scripting}/list-or-fetch.md | 0 .../scripting}/meilisearch-sync.md | 0 .../scripting}/paginated-list.md | 0 .../scripting}/sidecar-records.md | 0 .../scripting}/update-or-delete.md | 0 .../scripting}/upsert-record.md | 0 .../docs/reference/{ => admin}/admin-api.md | 0 packages/docs/sidebars.ts | 86 +++++++++---------- 29 files changed, 43 insertions(+), 43 deletions(-) rename packages/docs/docs/{reference => getting-started}/production-deployment.md (100%) rename packages/docs/docs/guides/{ => admin}/api-keys.md (100%) rename packages/docs/docs/guides/{ => admin}/event-logs.md (100%) rename packages/docs/docs/guides/{ => admin}/permissions.md (100%) rename packages/docs/docs/guides/{ => database}/database-setup.md (100%) rename packages/docs/docs/guides/{ => database}/postgres-to-sqlite-migration.md (100%) rename packages/docs/docs/guides/{ => database}/sqlite-to-postgres-migration.md (100%) rename packages/docs/docs/guides/{ => features}/api-clients.md (100%) rename packages/docs/docs/guides/{ => features}/developing-plugins.md (100%) rename packages/docs/docs/guides/{ => features}/labelers.md (100%) rename packages/docs/docs/guides/{ => features}/plugins.md (100%) rename packages/docs/docs/guides/{ => indexing}/backfill.md (100%) rename packages/docs/docs/guides/{ => indexing}/index-hooks.md (100%) rename packages/docs/docs/guides/{ => indexing}/lexicons.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/algolia-sync.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/batch-save.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/cascading-delete.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/complex-mutations.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/create-record.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/expanded-query.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/get-record.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/list-or-fetch.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/meilisearch-sync.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/paginated-list.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/sidecar-records.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/update-or-delete.md (100%) rename packages/docs/docs/{reference/scripts => guides/scripting}/upsert-record.md (100%) rename packages/docs/docs/reference/{ => admin}/admin-api.md (100%) diff --git a/packages/docs/docs/reference/production-deployment.md b/packages/docs/docs/getting-started/production-deployment.md similarity index 100% rename from packages/docs/docs/reference/production-deployment.md rename to packages/docs/docs/getting-started/production-deployment.md diff --git a/packages/docs/docs/guides/api-keys.md b/packages/docs/docs/guides/admin/api-keys.md similarity index 100% rename from packages/docs/docs/guides/api-keys.md rename to packages/docs/docs/guides/admin/api-keys.md diff --git a/packages/docs/docs/guides/event-logs.md b/packages/docs/docs/guides/admin/event-logs.md similarity index 100% rename from packages/docs/docs/guides/event-logs.md rename to packages/docs/docs/guides/admin/event-logs.md diff --git a/packages/docs/docs/guides/permissions.md b/packages/docs/docs/guides/admin/permissions.md similarity index 100% rename from packages/docs/docs/guides/permissions.md rename to packages/docs/docs/guides/admin/permissions.md diff --git a/packages/docs/docs/guides/database-setup.md b/packages/docs/docs/guides/database/database-setup.md similarity index 100% rename from packages/docs/docs/guides/database-setup.md rename to packages/docs/docs/guides/database/database-setup.md diff --git a/packages/docs/docs/guides/postgres-to-sqlite-migration.md b/packages/docs/docs/guides/database/postgres-to-sqlite-migration.md similarity index 100% rename from packages/docs/docs/guides/postgres-to-sqlite-migration.md rename to packages/docs/docs/guides/database/postgres-to-sqlite-migration.md diff --git a/packages/docs/docs/guides/sqlite-to-postgres-migration.md b/packages/docs/docs/guides/database/sqlite-to-postgres-migration.md similarity index 100% rename from packages/docs/docs/guides/sqlite-to-postgres-migration.md rename to packages/docs/docs/guides/database/sqlite-to-postgres-migration.md diff --git a/packages/docs/docs/guides/api-clients.md b/packages/docs/docs/guides/features/api-clients.md similarity index 100% rename from packages/docs/docs/guides/api-clients.md rename to packages/docs/docs/guides/features/api-clients.md diff --git a/packages/docs/docs/guides/developing-plugins.md b/packages/docs/docs/guides/features/developing-plugins.md similarity index 100% rename from packages/docs/docs/guides/developing-plugins.md rename to packages/docs/docs/guides/features/developing-plugins.md diff --git a/packages/docs/docs/guides/labelers.md b/packages/docs/docs/guides/features/labelers.md similarity index 100% rename from packages/docs/docs/guides/labelers.md rename to packages/docs/docs/guides/features/labelers.md diff --git a/packages/docs/docs/guides/plugins.md b/packages/docs/docs/guides/features/plugins.md similarity index 100% rename from packages/docs/docs/guides/plugins.md rename to packages/docs/docs/guides/features/plugins.md diff --git a/packages/docs/docs/guides/backfill.md b/packages/docs/docs/guides/indexing/backfill.md similarity index 100% rename from packages/docs/docs/guides/backfill.md rename to packages/docs/docs/guides/indexing/backfill.md diff --git a/packages/docs/docs/guides/index-hooks.md b/packages/docs/docs/guides/indexing/index-hooks.md similarity index 100% rename from packages/docs/docs/guides/index-hooks.md rename to packages/docs/docs/guides/indexing/index-hooks.md diff --git a/packages/docs/docs/guides/lexicons.md b/packages/docs/docs/guides/indexing/lexicons.md similarity index 100% rename from packages/docs/docs/guides/lexicons.md rename to packages/docs/docs/guides/indexing/lexicons.md diff --git a/packages/docs/docs/reference/scripts/algolia-sync.md b/packages/docs/docs/guides/scripting/algolia-sync.md similarity index 100% rename from packages/docs/docs/reference/scripts/algolia-sync.md rename to packages/docs/docs/guides/scripting/algolia-sync.md diff --git a/packages/docs/docs/reference/scripts/batch-save.md b/packages/docs/docs/guides/scripting/batch-save.md similarity index 100% rename from packages/docs/docs/reference/scripts/batch-save.md rename to packages/docs/docs/guides/scripting/batch-save.md diff --git a/packages/docs/docs/reference/scripts/cascading-delete.md b/packages/docs/docs/guides/scripting/cascading-delete.md similarity index 100% rename from packages/docs/docs/reference/scripts/cascading-delete.md rename to packages/docs/docs/guides/scripting/cascading-delete.md diff --git a/packages/docs/docs/reference/scripts/complex-mutations.md b/packages/docs/docs/guides/scripting/complex-mutations.md similarity index 100% rename from packages/docs/docs/reference/scripts/complex-mutations.md rename to packages/docs/docs/guides/scripting/complex-mutations.md diff --git a/packages/docs/docs/reference/scripts/create-record.md b/packages/docs/docs/guides/scripting/create-record.md similarity index 100% rename from packages/docs/docs/reference/scripts/create-record.md rename to packages/docs/docs/guides/scripting/create-record.md diff --git a/packages/docs/docs/reference/scripts/expanded-query.md b/packages/docs/docs/guides/scripting/expanded-query.md similarity index 100% rename from packages/docs/docs/reference/scripts/expanded-query.md rename to packages/docs/docs/guides/scripting/expanded-query.md diff --git a/packages/docs/docs/reference/scripts/get-record.md b/packages/docs/docs/guides/scripting/get-record.md similarity index 100% rename from packages/docs/docs/reference/scripts/get-record.md rename to packages/docs/docs/guides/scripting/get-record.md diff --git a/packages/docs/docs/reference/scripts/list-or-fetch.md b/packages/docs/docs/guides/scripting/list-or-fetch.md similarity index 100% rename from packages/docs/docs/reference/scripts/list-or-fetch.md rename to packages/docs/docs/guides/scripting/list-or-fetch.md diff --git a/packages/docs/docs/reference/scripts/meilisearch-sync.md b/packages/docs/docs/guides/scripting/meilisearch-sync.md similarity index 100% rename from packages/docs/docs/reference/scripts/meilisearch-sync.md rename to packages/docs/docs/guides/scripting/meilisearch-sync.md diff --git a/packages/docs/docs/reference/scripts/paginated-list.md b/packages/docs/docs/guides/scripting/paginated-list.md similarity index 100% rename from packages/docs/docs/reference/scripts/paginated-list.md rename to packages/docs/docs/guides/scripting/paginated-list.md diff --git a/packages/docs/docs/reference/scripts/sidecar-records.md b/packages/docs/docs/guides/scripting/sidecar-records.md similarity index 100% rename from packages/docs/docs/reference/scripts/sidecar-records.md rename to packages/docs/docs/guides/scripting/sidecar-records.md diff --git a/packages/docs/docs/reference/scripts/update-or-delete.md b/packages/docs/docs/guides/scripting/update-or-delete.md similarity index 100% rename from packages/docs/docs/reference/scripts/update-or-delete.md rename to packages/docs/docs/guides/scripting/update-or-delete.md diff --git a/packages/docs/docs/reference/scripts/upsert-record.md b/packages/docs/docs/guides/scripting/upsert-record.md similarity index 100% rename from packages/docs/docs/reference/scripts/upsert-record.md rename to packages/docs/docs/guides/scripting/upsert-record.md diff --git a/packages/docs/docs/reference/admin-api.md b/packages/docs/docs/reference/admin/admin-api.md similarity index 100% rename from packages/docs/docs/reference/admin-api.md rename to packages/docs/docs/reference/admin/admin-api.md diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.ts index 45b4eb6..99da384 100644 --- a/packages/docs/sidebars.ts +++ b/packages/docs/sidebars.ts @@ -16,6 +16,21 @@ const sidebars: SidebarsConfig = { id: "getting-started/quickstart", label: "Quickstart", }, + { + type: "doc", + id: "getting-started/configuration", + label: "Configuration", + }, + { + type: "doc", + id: "getting-started/dashboard", + label: "Dashboard", + }, + { + type: "doc", + id: "getting-started/authentication", + label: "Authentication", + }, { type: "category", label: "Deployment", @@ -37,26 +52,11 @@ const sidebars: SidebarsConfig = { }, { type: "doc", - id: "reference/production-deployment", + id: "getting-started/production-deployment", label: "Production", }, ], }, - { - type: "doc", - id: "getting-started/configuration", - label: "Configuration", - }, - { - type: "doc", - id: "getting-started/authentication", - label: "Authentication", - }, - { - type: "doc", - id: "getting-started/dashboard", - label: "Dashboard", - }, ], }, { @@ -80,17 +80,17 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "guides/lexicons", + id: "guides/indexing/lexicons", label: "Lexicons", }, { type: "doc", - id: "guides/backfill", + id: "guides/indexing/backfill", label: "Backfill", }, { type: "doc", - id: "guides/index-hooks", + id: "guides/indexing/index-hooks", label: "Index Hooks", }, ], @@ -110,67 +110,67 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "reference/scripts/get-record", + id: "guides/scripting/get-record", label: "Get a Record", }, { type: "doc", - id: "reference/scripts/create-record", + id: "guides/scripting/create-record", label: "Create Record", }, { type: "doc", - id: "reference/scripts/upsert-record", + id: "guides/scripting/upsert-record", label: "Upsert Record", }, { type: "doc", - id: "reference/scripts/paginated-list", + id: "guides/scripting/paginated-list", label: "Paginated List", }, { type: "doc", - id: "reference/scripts/list-or-fetch", + id: "guides/scripting/list-or-fetch", label: "List or Fetch", }, { type: "doc", - id: "reference/scripts/expanded-query", + id: "guides/scripting/expanded-query", label: "Expanded Query", }, { type: "doc", - id: "reference/scripts/update-or-delete", + id: "guides/scripting/update-or-delete", label: "Update or Delete", }, { type: "doc", - id: "reference/scripts/batch-save", + id: "guides/scripting/batch-save", label: "Batch Save", }, { type: "doc", - id: "reference/scripts/sidecar-records", + id: "guides/scripting/sidecar-records", label: "Sidecar Records", }, { type: "doc", - id: "reference/scripts/cascading-delete", + id: "guides/scripting/cascading-delete", label: "Cascading Delete", }, { type: "doc", - id: "reference/scripts/complex-mutations", + id: "guides/scripting/complex-mutations", label: "Complex Mutations", }, { type: "doc", - id: "reference/scripts/algolia-sync", + id: "guides/scripting/algolia-sync", label: "Algolia Sync", }, { type: "doc", - id: "reference/scripts/meilisearch-sync", + id: "guides/scripting/meilisearch-sync", label: "Meilisearch Sync", }, ], @@ -183,22 +183,22 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "guides/api-clients", + id: "guides/features/api-clients", label: "API Clients", }, { type: "doc", - id: "guides/labelers", + id: "guides/features/labelers", label: "Labelers", }, { type: "doc", - id: "guides/plugins", + id: "guides/features/plugins", label: "Plugins", }, { type: "doc", - id: "guides/developing-plugins", + id: "guides/features/developing-plugins", label: "Developing Plugins", }, ], @@ -209,17 +209,17 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "guides/api-keys", + id: "guides/admin/api-keys", label: "API Keys", }, { type: "doc", - id: "guides/permissions", + id: "guides/admin/permissions", label: "Permissions", }, { type: "doc", - id: "guides/event-logs", + id: "guides/admin/event-logs", label: "Event Logs", }, ], @@ -230,17 +230,17 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "guides/database-setup", + id: "guides/database/database-setup", label: "Database Setup", }, { type: "doc", - id: "guides/postgres-to-sqlite-migration", + id: "guides/database/postgres-to-sqlite-migration", label: "Postgres → SQLite Migration", }, { type: "doc", - id: "guides/sqlite-to-postgres-migration", + id: "guides/database/sqlite-to-postgres-migration", label: "SQLite → Postgres Migration", }, ], @@ -288,7 +288,7 @@ const sidebars: SidebarsConfig = { items: [ { type: "doc", - id: "reference/admin-api", + id: "reference/admin/admin-api", label: "Overview", }, { -- 2.51.2