docs(055): documentation Diátaxis restructure — spec (WP-G1)#522
Open
Dumbris wants to merge 1 commit into
Open
docs(055): documentation Diátaxis restructure — spec (WP-G1)#522Dumbris wants to merge 1 commit into
Dumbris wants to merge 1 commit into
Conversation
Related #N/A Spec for restructuring docs.mcpproxy.app around the four Diataxis quadrants: add the missing Tutorials + Explanation quadrants, decompose the features/ catch-all, remove ~62 internal artifacts from docs/, publish code_execution/, keep Docusaurus + add redirects, freeze /errors/ URLs.
Deploying mcpproxy-docs with
|
| Latest commit: |
bb35256
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b72f3cbf.mcpproxy-docs.pages.dev |
| Branch Preview URL: | https://055-docs-diataxis.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 26351798392 --repo smart-mcp-proxy/mcpproxy-go
|
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.
Spec for restructuring docs.mcpproxy.app around the four Diátaxis quadrants (Spec 053 WP-G1). Based on a full docs inventory: the site is Docusaurus (keep it), ~133 files in
docs/with only ~71 published.Problems it fixes:
features/directory is a catch-all mixing Explanation + Reference + How-to in nearly every page.docs/and risk accidental publication.What the spec requires: add Tutorials + Explanation quadrants (incl. a verified 'Your first proxy' tutorial and a unified security-model page), decompose + retire
features/, dedup stale copies, publish the ready-madecode_execution/set, move internal artifacts out ofdocs/, add client redirects for moved pages, and freeze/errors/<CODE>URLs (hard-linked from product code).Non-goals: no Go changes, no generator migration, no marketing-site changes. Est. ~11–15 days, deliverable incrementally. Spec-only; quality checklist passes. Plan to be run later.