docs(site): sidebar coverage for all user-facing pages + exclude internal docs - #1001
Merged
Conversation
…rnal docs https://docs.mcpproxy.app/features/tools-preflight/ rendered without a left sidebar: website/sidebars.js is a manual sidebar and the page had no entry, so Docusaurus treated it as an orphan. 37 published pages were orphaned this way. - sidebars.js: add all 37 orphans. Features gains Security / Isolation / Authentication subcategories so the flat list stays navigable; code_execution/ becomes a "Code Execution" category linked from the features/code-execution page; the 4 missing error codes join their existing groups. - docusaurus.config.js: publish code_execution/** and the six root references with no structured counterpart (cli-client-mode, cli-output-formatting, logging, prerelease-builds, registries, socket-communication); exclude the two internal sandbox spike/harness write-ups under development/. - Add title/sidebar_label/description frontmatter to the 27 newly-navigable pages that had none, and repoint cross-links that targeted unpublished docs. Build is clean: zero broken links, zero broken anchors, 165 documents.
Deploying mcpproxy-docs with
|
| Latest commit: |
4402a88
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2e670e8b.mcpproxy-docs.pages.dev |
| Branch Preview URL: | https://docs-site-consistency.mcpproxy-docs.pages.dev |
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
📦 Build ArtifactsWorkflow Run: View Run Available Artifacts
How to DownloadOption 1: GitHub Web UI (easiest)
Option 2: GitHub CLI gh run download 32008249342 --repo smart-mcp-proxy/mcpproxy-go
|
Dumbris
enabled auto-merge (squash)
August 17, 2026 08:50
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Trigger
https://docs.mcpproxy.app/features/tools-preflight/ renders without the left sidebar while
features/code-executionrenders with it.website/sidebars.jsis a manual sidebar;features/tools-preflighthad no entry, so Docusaurus rendered it as an orphan page.Pipeline note
website/docs/is gitignored —website/prepare-docs.shcopies../docsinto it on everynpm run build/start. The source of truth is the repo'sdocs/, which is what this PR edits. The docs plugin uses anincludeallowlist (not excludes), soplans/,designs/,proposals/,code-reviews/,followups/,bugs/,qa/and most root*.mdwere never published in the first place.Triage
Measured against the include allowlist, 37 published pages were orphaned (not the ~102 counted across all of
docs/, most of which are unpublished).Added to nav — 37 orphans + 5 newly published pages, across:
security-commands,credential-commands,cli-client-mode,cli-output-formattingserver-detail,activity-log,settings-pagerouting-modes,tools-preflight,profiles,connect-clients,config-import,registry-add,toon-output,telemetry+ new Security (9), Isolation (2), Authentication (3) subcategoriescode_execution/overview, api-reference, examples, cookbook, troubleshootingobservability,logging,socket-communication,registries,linux-package-repos+ its ops runbook,prerelease-buildsMCPX_STDIO_EXIT_BEFORE_INITIALIZE,MCPX_OAUTH_LOGIN_REQUIRED,MCPX_OAUTH_REAUTH_REQUIRED,MCPX_DOCKER_EXEC_NOT_FOUNDweb-ui-verification,macos-tray,release-gate,server-edition-multiuser-auth,quarantine-testing,scanner-imagesExcluded — 2 internal write-ups, via a new
excludelist:development/sandbox-spike-mcp-34.md(spike recommendation) anddevelopment/sandbox-snap-docker-harness.md(manual reproduction harness). They stay in the repo.Judgment calls
code_execution/vsfeatures/code-executionare not redundant: the feature page is a 362-line overview,code_execution/is 4,474 lines of deep reference. Linked coherently — the feature page is the category's landing doc and the five reference pages sit under it.configuration.md,cli-management-commands.md,architecture.md,setup.md,docker-isolation.md. Each is a longer variant of a page already on the site; publishing both would create two competing references and split search. Folding them is a content merge worth doing separately. Only root docs with no counterpart were added.search_servers.mdis a design document, not user docs — left unpublished.features/quarantine-testingandfeatures/scanner-imagesare contributor-facing despite living underfeatures/, so they sit in Development.Consistency pass
title/sidebar_label/descriptionfrontmatter to the 27 newly-navigable pages that had none.registries.md→configuration/config-file, the twocode_executionlinks to../configuration.mdand one tobench/README.md→ GitHub URLs, andfeatures/sandbox-isolation→ the now-excluded spike on GitHub.code_execution/cookbook.md(its table of contents used slugs that don't match Docusaurus's slugification of the non-breaking hyphens in those headings).Verification
cd website && npm run build:Zero broken links, zero broken anchors. Post-build check confirms 108 published pages, 0 remaining orphans, and
build/features/tools-preflight/index.htmlnow renders withtheme-doc-sidebar-container. The one remaining warning (Description for "Implementing OAuth Authentication…" is very long) is pre-existing and unrelated.