Repository navigation
Replace GitHub Wiki sync with MkDocs Material site - #42
Merged
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
🔵 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
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.
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:
Wiki syncGitHub Actions workflow and associated publishing instructions, discontinuing the use of the GitHub Wiki for documentation. [1] [2] [3]Deploy wikiworkflow that builds documentation with MkDocs and deploys it to GitHub Pages on pushes tomainormaster.MkDocs configuration and structure:
mkdocs.ymlfile configuring the site theme, navigation, and plugins for the new documentation site.docs/wiki/todocs/, converting wiki link syntax to standard Markdown and updating internal references to.mdfiles. [1] [2] [3]Documentation content updates: