Repository navigation
Replace GitHub Wiki sync with MkDocs Material site on GitHub Pages - #41
Merged
Merged
Conversation
Co-authored-by: JannisHeydemann <149153326+JannisHeydemann@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
JannisHeydemann
October 22, 2026 08:44
JannisHeydemann
approved these changes
Oct 22, 2026
JannisHeydemann
approved these changes
Oct 22, 2026
Contributor
There was a problem hiding this comment.
🟢 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
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.
Moves project docs off the native GitHub Wiki to a static MkDocs (Material) site deployed via GitHub Pages Actions.
Removed wiki sync
.github/workflows/wiki-sync.ymlanddocs/wiki/_Sidebar.md, whichnavinmkdocs.ymlreplaces.Docs layout
docs/wiki/*up todocs/so the defaultdocs_dirand thedocs/**trigger line up.Home.mdis nowdocs/index.md(the homepage). The other pages keep their filenames.[[wiki]]links as relative Markdown links, which MkDocs requires.Contributing.mdnote that described the old wiki sync.mkdocs.ymlnav: Home, Game Mechanics, Code Documentation, Contributing..github/workflows/deploy-wiki.ymlmainormasterthat touchdocs/**,mkdocs.yml, or the workflow file.workflow_dispatchis also enabled.mkdocs-material, andmkdocs build --strict.configure-pages,upload-pages-artifactanddeploy-pages.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.