docs: migrate from MkDocs/GitHub Pages to GitBook#391
Merged
Conversation
- Add scripts/convert_to_gitbook.py to copy docs/ → site/, inline --8<-- snippets, convert admonitions/tabs/footnotes to GitBook syntax, and write SUMMARY.md - Add .gitbook.yaml and .gitbook-branch-readme.md - Replace docs.yml workflow: runs conversion script and rsyncs site/ to gitbook-docs branch on push to main - Remove mkdocs.yml and mkdocs dep group from pyproject.toml - Update Justfile docs target to run conversion script - Update <picture> elements in README.md and docs/index.md to GitBook- recommended dark/light mode syntax Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
- Replace regex-heavy conversion script with simple copy + snippet inliner - Add check_docs.py for internal link/anchor validation - Wire docs-check and docs-build into just docs - Update CI workflow to call just docs for local/CI parity
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
3 participants
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.
Replaces the MkDocs + GitHub Pages docs pipeline with a GitBook-based one.
To test locally: python scripts/convert_to_gitbook.py — output lands in site/