setup docs site with docs as source of truth#3987
Open
rbessin wants to merge 3 commits intodocumentationfrom
Open
setup docs site with docs as source of truth#3987rbessin wants to merge 3 commits intodocumentationfrom
rbessin wants to merge 3 commits intodocumentationfrom
Conversation
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
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.
Changes
Set up a Docusaurus documentation site where
docs-site/docs/is the source of truth and Claude skills are automatically generated from flagged documentation.Architecture:
docs-site/docs/(tracked in Git).claude/skills/(gitignored, synced viayarn skills:sync)Implementation:
docs-siteas yarn workspace for unified dependency managementsync-skills.js: transforms docs withskill: true→.claude/skills/SKILL.mdformatgenerate-sidebar.js: auto-generates sidebar from folder structureDeveloper Workflow:
docs-site/docs/yarn docs:dev→ preview at localhost:3002 (sidebar auto-generates)yarn skills:sync→ update.claude/skills/(if doc hasskill: true)docs-site/docs/Notes
.claude/skills/gitignored: now auto-generated, not trackedTest Cases
yarn docs:devstarts dev server at localhost:3002yarn docs:buildbuilds production site without errorsyarn skills:syncgenerates 7 SKILL.md files (excludes Postman)docs-site/docs/filesScreenshots
Checklist
No- workspace integration (expected)yarn.lockchangesCloses #3978