Migrate pages flow to mkpages - #120
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the GitHub Pages documentation build pipeline from a custom Python script that generated a Jekyll-friendly source tree to a mkpages-based flow.
Changes:
- Remove
scripts/build_pages_site.py(custom Jekyll source generator). - Add
docs/mkpages.ymland switch the Pages workflow to runmkpages buildand then Jekyll. - Minor docs + repo housekeeping updates (
docs/index.mdimage sizing, ignore.mkpages/output).
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/build_pages_site.py | Removes the bespoke markdown-to-Jekyll source generator (links/mermaid/front-matter/layout/assets handling). |
| docs/mkpages.yml | Adds mkpages site configuration (metadata + top navigation). |
| docs/index.md | Tweaks landing page logo width. |
| .gitignore | Adds .mkpages/ to ignore mkpages build output. |
| .github/workflows/publish-docs.yml | Installs and runs mkpages to generate the Jekyll source used for Pages deployment. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
This pull request updates the documentation build process and site configuration for the project. The most significant changes include switching to the
mkpagesstatic site generator, hadding a dedicated configuration file for documentation, and making a small visual adjustment to the logo size on the homepage.Documentation build process improvements:
.github/workflows/publish-docs.ymlto install and usemkpagesfor building documentation, replacing the previous Python script. The output directory and Jekyll source have been updated accordingly.Documentation site configuration:
docs/mkpages.ymlconfiguration file specifying site metadata (title, description, theme, favicon) and navigation structure for the documentation site.Visual adjustments:
docs/index.mdfor better visual balance.