Skip to content

Replace GitHub Wiki sync with MkDocs Material site - #42

Merged
JannisHeydemann merged 3 commits into
masterfrom
dev
Oct 22, 2026
Merged

JannisHeydemann merged 3 commits into
masterfrom
dev

Conversation

@JannisHeydemann

Copy link
Copy Markdown
Owner

Merge pull request #37 from JannisHeydemann/dev
This pull request migrates the project documentation system from a GitHub Wiki-based workflow to a MkDocs-based static site hosted on GitHub Pages. It removes the old wiki sync workflow, introduces a new deployment workflow for MkDocs, and updates documentation files and references to reflect the new system.

Documentation workflow migration:

  • Removed the old Wiki sync GitHub Actions workflow and associated publishing instructions, discontinuing the use of the GitHub Wiki for documentation. [1] [2] [3]
  • Added a new Deploy wiki workflow that builds documentation with MkDocs and deploys it to GitHub Pages on pushes to main or master.

MkDocs configuration and structure:

  • Introduced a mkdocs.yml file configuring the site theme, navigation, and plugins for the new documentation site.
  • Renamed and updated documentation files from docs/wiki/ to docs/, converting wiki link syntax to standard Markdown and updating internal references to .md files. [1] [2] [3]

Documentation content updates:

  • Updated documentation instructions to reference the new MkDocs-based system and GitHub Pages deployment, replacing references to the old wiki workflow.

JannisHeydemann and others added 3 commits October 21, 2026 08:49
Merge pull request #37 from JannisHeydemann/dev
Co-authored-by: JannisHeydemann <149153326+JannisHeydemann@users.noreply.github.com>
…ync-workflow

Replace GitHub Wiki sync with MkDocs Material site on GitHub Pages
Copilot AI lite review requested due to automatic review settings October 22, 2026 08:48

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.

🔵 Needs a closer look

The deployment dependencies are unpinned, and workflow naming and contribution instructions remain inconsistent with the new documentation system.

No open issues 🎉

What changed in this PR

This pull request replaces GitHub Wiki synchronization with an MkDocs Material site deployed to GitHub Pages.

Changes:

  • Adds MkDocs configuration, navigation, and Material theme settings.
  • Adds a GitHub Pages deployment workflow and removes the obsolete Wiki sync workflow.
  • Migrates documentation links and publishing instructions to the MkDocs structure.
File Reviewed change
mkdocs.yml Configures the MkDocs Material site, plugins, theme, and navigation.
docs/​wiki/​_Sidebar.md Removes the obsolete Wiki sidebar.
docs/​index.md Updates documentation links for MkDocs.
docs/​Game-Mechanics.md Updates the Code Documentation reference.
docs/​Contributing.md Updates documentation publishing instructions; branch and terminology references require correction.
docs/​Code-Documentation.md Updates the Contributing documentation link.
.github/​workflows/​wiki-sync.yml Removes the legacy GitHub Wiki synchronization workflow.
.github/​workflows/​deploy-wiki.yml Builds and deploys the MkDocs site to GitHub Pages; dependency pinning and workflow naming require updates.

Review effort: Lite

@JannisHeydemann
JannisHeydemann merged commit acd54dc into master Oct 22, 2026
7 checks passed
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