Repository navigation
📝 docs: sync package READMEs into docs site - #111
Merged
Merged
Conversation
- Auto-discover all packages/* READMEs; curated list keeps title/icon/category, unknown packages fall back to an "Other" category with the Package icon - Add legal-terms and test-google-login pages - Only delete previously generated pages, keeping hand-written ones - New docs-sync workflow runs the sync on master and commits the result Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015dyCoRoTVAB3QpHcd93Uo8
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This branch had an error being deployed
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.
Syncs package README files into the documentation site as MDX pages, with auto-discovery of new packages and CI automation.
Changes
test-google-loginandlegal-terms-privacy-policypackages, synced from their README filessync-readme-docs.tsto automatically discover and sync anypackages/*/README.mdnot in the curated list, placing undocumented packages under an "Other" category with a default icon.github/workflows/docs-sync.ymlworkflow that automatically syncs README changes on push to master and commits the result, ensuring docs stay current without manual interventionreadPackageJson()helper for reusereadPackageName()to read package names frompackage.jsonlegal-terms-privacy-policyandtest-google-loginto the docs navigation metadataImplementation Details
The sync script now discovers packages in two ways:
PACKAGES): Manually configured packages with custom titles, icons, and categoriespackages/*/directory with a README that isn't in the curated list gets a page under "Other" with the package name frompackage.jsonand a default iconThe CI workflow runs on changes to package READMEs,
package.jsonfiles, or the sync script itself, ensuring documentation stays synchronized with source changes.https://claude.ai/code/session_015dyCoRoTVAB3QpHcd93Uo8