docs: automate MkDocs to GitHub Wiki synchronization - #14
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1fdeca4c06
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const EXCLUDED_DOCUMENTS = new Set([ | ||
| "COLOR_PIPELINE_NOTES.md", | ||
| "DOCS_ARCHITECTURE.md", | ||
| "JABCODE_NOTES.md", | ||
| ]); |
There was a problem hiding this comment.
Derive excluded pages from the MkDocs configuration
When a page is later added to mkdocs.yml's exclude_docs, this fixed basename list will still copy it into the public Wiki, so drafts explicitly removed from the published MkDocs site can be exposed on the next synchronization; removing an exclusion has the inverse problem. Because the workflow deliberately runs when mkdocs.yml changes, the generator should consume that configuration or otherwise keep the exclusion rules in one canonical source.
Useful? React with 👍 / 👎.
Summary
docs/as the canonical source and preserve manually managed Wiki pages.Verification
npm run lintnpm run test:docsnpm run typesnode --check tools/sync-wiki.mjsgit diff --check