Skip to content

Replace GitHub Wiki sync with MkDocs Material site on GitHub Pages - #41

Merged
JannisHeydemann merged 1 commit into
devfrom
copilot/remove-old-wiki-sync-workflow
Oct 22, 2026
Merged

JannisHeydemann merged 1 commit into
devfrom
copilot/remove-old-wiki-sync-workflow

Conversation

Copilot AI commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Moves project docs off the native GitHub Wiki to a static MkDocs (Material) site deployed via GitHub Pages Actions.

  • Removed wiki sync

    • Deleted .github/workflows/wiki-sync.yml and docs/wiki/_Sidebar.md, which nav in mkdocs.yml replaces.
  • Docs layout

    • Moved docs/wiki/* up to docs/ so the default docs_dir and the docs/** trigger line up.
    • Home.md is now docs/index.md (the homepage). The other pages keep their filenames.
    • Rewrote [[wiki]] links as relative Markdown links, which MkDocs requires.
    • Updated the Contributing.md note that described the old wiki sync.
  • mkdocs.yml

    • Material theme with instant navigation, search suggestions and highlighting, a light/dark toggle, and code copy buttons.
    • Explicit nav: Home, Game Mechanics, Code Documentation, Contributing.
  • .github/workflows/deploy-wiki.yml

    • Triggers on pushes to main or master that touch docs/**, mkdocs.yml, or the workflow file. workflow_dispatch is also enabled.
    • Builds with Python 3.11, mkdocs-material, and mkdocs build --strict.
    • Deploys with configure-pages, upload-pages-artifact and deploy-pages.
    • Permissions: contents: read, pages: write, id-token: write.

Required after merge: set Settings → Pages → Build and deployment → Source to GitHub Actions. The site is then served at https://jannisheydemann.github.io/TJM/. The Wiki feature can be disabled under Settings → General → Features.

Co-authored-by: JannisHeydemann <149153326+JannisHeydemann@users.noreply.github.com>
@JannisHeydemann
JannisHeydemann marked this pull request as ready for review October 22, 2026 08:45
@JannisHeydemann
JannisHeydemann merged commit 62fca1f into dev Oct 22, 2026
3 checks passed
@JannisHeydemann
JannisHeydemann deleted the copilot/remove-old-wiki-sync-workflow branch October 22, 2026 08:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approved

The remaining workflow naming and publishing-instruction findings are non-blocking documentation nits.

No open issues 🎉

What changed in this PR

This pull request replaces GitHub Wiki synchronization with an MkDocs Material documentation site deployed through GitHub Pages Actions.

Changes:

  • Moves documentation into the standard docs/ directory and updates links for MkDocs.
  • Adds MkDocs Material configuration with navigation, search, theming, and Markdown extensions.
  • Replaces the obsolete Wiki sync workflow with a GitHub Pages build-and-deploy workflow.
File Description
mkdocs.yml Configures the MkDocs Material site, theme, plugins, extensions, and navigation.
docs/​wiki/​_Sidebar.md Removes the obsolete GitHub Wiki sidebar.
docs/​index.md Defines the documentation site homepage and links to its sections.
docs/​Game-Mechanics.md Updates the code documentation link for MkDocs.
docs/​Contributing.md Updates documentation publishing instructions for MkDocs and GitHub Pages.
docs/​Code-Documentation.md Updates the contributing documentation link for MkDocs.
.github/​workflows/​wiki-sync.yml Removes the obsolete GitHub Wiki synchronization workflow.
.github/​workflows/​deploy-wiki.yml Builds and deploys the MkDocs site through GitHub Pages Actions.

Review effort: Lite

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.

3 participants