From ada6cda9229f3e72048d68d3f0ed4d192145fbe5 Mon Sep 17 00:00:00 2001 From: Josh Smith <6895577+joshsmithxrm@users.noreply.github.com> Date: Sat, 25 Apr 2026 09:16:02 -0500 Subject: [PATCH 1/2] fix(sidebar): wire generated reference pages into sidebar navigation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Switch Reference subcategories (CLI, Libraries, MCP) from manual item lists to autogenerated sidebar items so all generated pages are discoverable - Add Extension category (was generated but missing from sidebar) - Rename _index.md → api-reference.md (Docusaurus ignores _ prefixed files) - overview.md pages become category landing links Co-Authored-By: Claude Opus 4.6 --- .../libraries/Auth/{_index.md => api-reference.md} | 0 .../Dataverse/{_index.md => api-reference.md} | 0 .../Migration/{_index.md => api-reference.md} | 0 .../Plugins/{_index.md => api-reference.md} | 0 docs/reference/mcp/{_index.md => api-reference.md} | 0 sidebars.ts | 14 +++++++++++--- 6 files changed, 11 insertions(+), 3 deletions(-) rename docs/reference/libraries/Auth/{_index.md => api-reference.md} (100%) rename docs/reference/libraries/Dataverse/{_index.md => api-reference.md} (100%) rename docs/reference/libraries/Migration/{_index.md => api-reference.md} (100%) rename docs/reference/libraries/Plugins/{_index.md => api-reference.md} (100%) rename docs/reference/mcp/{_index.md => api-reference.md} (100%) diff --git a/docs/reference/libraries/Auth/_index.md b/docs/reference/libraries/Auth/api-reference.md similarity index 100% rename from docs/reference/libraries/Auth/_index.md rename to docs/reference/libraries/Auth/api-reference.md diff --git a/docs/reference/libraries/Dataverse/_index.md b/docs/reference/libraries/Dataverse/api-reference.md similarity index 100% rename from docs/reference/libraries/Dataverse/_index.md rename to docs/reference/libraries/Dataverse/api-reference.md diff --git a/docs/reference/libraries/Migration/_index.md b/docs/reference/libraries/Migration/api-reference.md similarity index 100% rename from docs/reference/libraries/Migration/_index.md rename to docs/reference/libraries/Migration/api-reference.md diff --git a/docs/reference/libraries/Plugins/_index.md b/docs/reference/libraries/Plugins/api-reference.md similarity index 100% rename from docs/reference/libraries/Plugins/_index.md rename to docs/reference/libraries/Plugins/api-reference.md diff --git a/docs/reference/mcp/_index.md b/docs/reference/mcp/api-reference.md similarity index 100% rename from docs/reference/mcp/_index.md rename to docs/reference/mcp/api-reference.md diff --git a/sidebars.ts b/sidebars.ts index 9d73a8d..77feec2 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -23,17 +23,25 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'CLI', - items: ['reference/cli/overview'], + link: { type: 'doc', id: 'reference/cli/overview' }, + items: [{ type: 'autogenerated', dirName: 'reference/cli' }], + }, + { + type: 'category', + label: 'Extension', + items: [{ type: 'autogenerated', dirName: 'reference/extension' }], }, { type: 'category', label: 'Libraries', - items: ['reference/libraries/overview'], + link: { type: 'doc', id: 'reference/libraries/overview' }, + items: [{ type: 'autogenerated', dirName: 'reference/libraries' }], }, { type: 'category', label: 'MCP', - items: ['reference/mcp/overview'], + link: { type: 'doc', id: 'reference/mcp/overview' }, + items: [{ type: 'autogenerated', dirName: 'reference/mcp' }], }, ], }, From 69454d61252ece86e20c166cfd68e8f6b8a610c7 Mon Sep 17 00:00:00 2001 From: Josh Smith <6895577+joshsmithxrm@users.noreply.github.com> Date: Sat, 25 Apr 2026 09:44:22 -0500 Subject: [PATCH 2/2] fix: rename overview.md to index.md, simplify sidebar, update links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename overview.md → index.md so Docusaurus uses them as category landing pages without duplication in the sidebar - Simplify sidebar to single autogenerated directive for reference/ - Update all internal links from /overview to directory paths - Update footer link in docusaurus.config.ts Co-Authored-By: Claude Opus 4.6 --- docs/getting-started/installation.md | 4 ++-- docs/guides/authentication.md | 4 ++-- docs/reference/cli/{overview.md => index.md} | 2 +- .../libraries/{overview.md => index.md} | 2 +- docs/reference/mcp/{overview.md => index.md} | 2 +- docusaurus.config.ts | 2 +- sidebars.ts | 23 ++----------------- 7 files changed, 10 insertions(+), 29 deletions(-) rename docs/reference/cli/{overview.md => index.md} (98%) rename docs/reference/libraries/{overview.md => index.md} (99%) rename docs/reference/mcp/{overview.md => index.md} (98%) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 4246799..5967a9f 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -87,5 +87,5 @@ Profile storage, credential providers, and Global Discovery Service integration. ## Next Steps - [Configure authentication](/docs/guides/authentication) to connect to your environment -- [Explore the CLI commands](/docs/reference/cli/overview) -- [Learn the libraries](/docs/reference/libraries/overview) +- [Explore the CLI commands](/docs/reference/cli) +- [Learn the libraries](/docs/reference/libraries) diff --git a/docs/guides/authentication.md b/docs/guides/authentication.md index 588992b..88de26e 100644 --- a/docs/guides/authentication.md +++ b/docs/guides/authentication.md @@ -343,5 +343,5 @@ ppds auth create ## Next steps -- [CLI Command Reference](/docs/reference/cli/overview) -- [Libraries Overview](/docs/reference/libraries/overview) +- [CLI Command Reference](/docs/reference/cli) +- [Libraries Overview](/docs/reference/libraries) diff --git a/docs/reference/cli/overview.md b/docs/reference/cli/index.md similarity index 98% rename from docs/reference/cli/overview.md rename to docs/reference/cli/index.md index 41b9c10..53e658a 100644 --- a/docs/reference/cli/overview.md +++ b/docs/reference/cli/index.md @@ -201,4 +201,4 @@ All four of the first variables must be set. Setting one to three of four is a h ## Next Steps - [Authentication](/docs/guides/authentication) — create profiles, service principal setup, federated auth -- [Libraries Overview](/docs/reference/libraries/overview) — the libraries the CLI is built on +- [Libraries Overview](/docs/reference/libraries) — the libraries the CLI is built on diff --git a/docs/reference/libraries/overview.md b/docs/reference/libraries/index.md similarity index 99% rename from docs/reference/libraries/overview.md rename to docs/reference/libraries/index.md index 2c5278c..8103dd4 100644 --- a/docs/reference/libraries/overview.md +++ b/docs/reference/libraries/index.md @@ -255,4 +255,4 @@ Breaking changes are listed in each package's `CHANGELOG.md` in the main repo: [ ## Next steps - [Authentication guide](/docs/guides/authentication) — profile creation and credential flows -- [CLI reference](/docs/reference/cli/overview) — commands built on these libraries +- [CLI reference](/docs/reference/cli) — commands built on these libraries diff --git a/docs/reference/mcp/overview.md b/docs/reference/mcp/index.md similarity index 98% rename from docs/reference/mcp/overview.md rename to docs/reference/mcp/index.md index 3ec9ce9..bf200a2 100644 --- a/docs/reference/mcp/overview.md +++ b/docs/reference/mcp/index.md @@ -133,5 +133,5 @@ Treat the MCP server the same way you treat an interactive CLI session: scope it - [Claude Code MCP docs](https://docs.claude.com/en/docs/claude-code/mcp) — host-side configuration and debugging - [modelcontextprotocol.io](https://modelcontextprotocol.io) — protocol specification -- [PPDS CLI reference](/docs/reference/cli/overview) — same backend, command-line surface +- [PPDS CLI reference](/docs/reference/cli) — same backend, command-line surface - [Authentication guide](/docs/guides/authentication) — create profiles for `--profile` diff --git a/docusaurus.config.ts b/docusaurus.config.ts index d5965b4..2533253 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -98,7 +98,7 @@ const config: Config = { items: [ { label: 'Getting Started', to: '/docs/getting-started/installation' }, { label: 'Guides', to: '/docs/guides/authentication' }, - { label: 'CLI Reference', to: '/docs/reference/cli/overview' }, + { label: 'CLI Reference', to: '/docs/reference/cli' }, ], }, { diff --git a/sidebars.ts b/sidebars.ts index 77feec2..7e345ff 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -21,27 +21,8 @@ const sidebars: SidebarsConfig = { label: 'Reference', items: [ { - type: 'category', - label: 'CLI', - link: { type: 'doc', id: 'reference/cli/overview' }, - items: [{ type: 'autogenerated', dirName: 'reference/cli' }], - }, - { - type: 'category', - label: 'Extension', - items: [{ type: 'autogenerated', dirName: 'reference/extension' }], - }, - { - type: 'category', - label: 'Libraries', - link: { type: 'doc', id: 'reference/libraries/overview' }, - items: [{ type: 'autogenerated', dirName: 'reference/libraries' }], - }, - { - type: 'category', - label: 'MCP', - link: { type: 'doc', id: 'reference/mcp/overview' }, - items: [{ type: 'autogenerated', dirName: 'reference/mcp' }], + type: 'autogenerated', + dirName: 'reference', }, ], },