Skip to content

docs: automate MkDocs to GitHub Wiki synchronization - #14

Closed
Sythos wants to merge 1 commit into
mainfrom
docs/wiki-sync
Closed

docs: automate MkDocs to GitHub Wiki synchronization#14
Sythos wants to merge 1 commit into
mainfrom
docs/wiki-sync

Conversation

@Sythos

@Sythos Sythos commented Sep 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • Synchronize the published MkDocs Markdown into the linked GitHub Wiki.
  • Keep docs/ as the canonical source and preserve manually managed Wiki pages.
  • Pin workflow actions and attribute generated Wiki commits to Sythos.

Verification

  • npm run lint
  • npm run test:docs
  • npm run types
  • node --check tools/sync-wiki.mjs
  • YAML parsing for the workflow and MkDocs configuration
  • git diff --check

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread tools/sync-wiki.mjs
Comment on lines +8 to +12
const EXCLUDED_DOCUMENTS = new Set([
"COLOR_PIPELINE_NOTES.md",
"DOCS_ARCHITECTURE.md",
"JABCODE_NOTES.md",
]);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@Sythos Sythos closed this Sep 10, 2026
@Sythos
Sythos deleted the docs/wiki-sync branch September 10, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant