Repository navigation
docs: publish the documentation as a GitHub Pages site - #1095
Merged
Merged
Conversation
Moves the GitHub wiki into wiki/ and builds it with MkDocs Material, published to https://tempus2016.github.io/taskmate/ by a new Docs workflow. Pull requests build in strict mode so broken links and anchors fail before they reach the site. The navigation follows the sections on the old wiki home page. Links in the README, contributing guide, issue templates and the admin panel's docs button now point at the new site, and the button's tooltip says documentation rather than wiki in every locale.
github-actions
Bot
added
documentation
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
1 participant
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 the documentation off the GitHub wiki and onto a GitHub Pages site built with MkDocs Material: https://tempus2016.github.io/taskmate/ (it goes live when this merges).
What's in it
wiki/: all 110 wiki pages and their images, copied as they are. About 1,400 internal links were rewritten from wiki style ([Text](Page-Name)) toPage-Name.md.mkdocs.yml: Material theme with a light/dark toggle, built-in search, a contents list on each page and an "edit this page" button. The navigation follows the six sections on the old wiki home page. Heading IDs use GitHub-style slugs, so existing#sectionlinks keep working..github/workflows/docs.yml: builds on PRs that touch the docs, and builds and deploys on main. The build runs in--strictmode with anchor validation, so a broken page link, anchor or image fails CI.requirements-docs.txt: MkDocs is pinned below 2.0, because MkDocs 2.0 drops the plugin and theme system that Material depends on.design-styles.pnganddashboard-kids.pngwere reduced to 256 colours so they fit under the 1 MBcheck-added-large-fileslimit..pre-commit-config.yaml:check-yamlnow skipsmkdocs.yml, because its!!pythonslugify tag can't be read by a plain YAML parser.The old wiki stays up. Each of its pages will get a short note linking to the same page on the new site, so existing links still lead somewhere.