docs: source the Mintlify docs site from docs/ - #2
Open
lzrscg wants to merge 1 commit into
Open
Conversation
…s site The hosted docs move to Mintlify (xspec.mintlify.site), pulling content directly from docs/ — no separate content copy: - add docs/docs.json (Mintlify config): nav mirroring the existing page order, the live site's theme, and redirects covering every URL of the current AI-generated site - rename docs/README.md -> docs/index.md so it serves as the site root - hoist each page's body H1 into frontmatter title (+ sidebarTitle where the nav label differs) so titles render once on the site - commit the site favicon; drop the Fumadocs site (website/) and its docs/meta.json; point README.md at the hosted site Also fold in the few verified improvements found while reviewing the AI-generated site against these docs: tag case-sensitivity note, invalid marker-usage examples, shadowing example, gitignore-pattern safety note, hash-independence consequence, and an edge-kind table in the overview. Co-Authored-By: Claude Fable 5 <[email protected]>
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
1 participant
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.
Makes
docs/the single source for the hosted docs site at xspec.mintlify.site, replacing the Fumadocs site underwebsite/.What's in here
docs/docs.json— Mintlify config: same theme/colors/GitHub button as the current site, nav in the docs' existing reading order (Guide / Reference and workflows), and redirects mapping all 27 URLs of today's AI-generated site onto the 11 real pages.docs/README.md→docs/index.mdso the overview serves as the site root.title, plussidebarTitlewhere the nav label differs) — Mintlify renders the frontmatter title, so body H1s would show twice. GitHub still shows the title via the frontmatter table.website/removed (Fumadocs, superseded by Mintlify) along withdocs/meta.json; README now links the hosted site.The AI-generated site content itself was checked claim-by-claim against
specs/SPEC.mdandsrc/: 22+ substantive errors (invented CLI output formats, a fabricated six-category impact model, a nonexistent--versionflag, wrong exit codes). The repo docs won every disputed case, so this PR ports nothing else from the site; the site gets regenerated from these files instead.Turning on auto-sync
After merging: in the Mintlify dashboard (xspec project → Settings → Git/GitHub), install the Mintlify GitHub App on
modularcloud/xspec. The deployment then tracksdocs/docs.jsononmainand every push todocs/deploys automatically.🤖 Generated with Claude Code