docs: add mdBook documentation with GitHub Pages#122
Merged
Conversation
- Create book/ directory with mdBook structure - Add chapters: introduction, installation, Python API, CLI, GUI, algorithms, reference - Add GitHub Actions workflow for docs deployment - Add pixi tasks: book, book-build - Add documentation badge to README - Update .gitignore for mdBook build output Closes #121 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add app icon to mdBook introduction page - Add cli and cli-debug pixi tasks for building CLI tool - Update .gitignore for test data symlink Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The edit-url-template was using book/{path} but source files are in
book/src/, causing 404s for "Edit this page" links.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive mdBook-based documentation for the rustpix project, deployed via GitHub Pages. The documentation covers installation, Python/CLI/GUI usage, clustering algorithms, and technical reference material.
Changes:
- Added mdBook documentation structure in
book/directory with comprehensive chapters covering installation, APIs, and technical references - Added GitHub Actions workflow (
.github/workflows/docs.yml) for building and deploying documentation to GitHub Pages - Added pixi tasks (
book,book-build) for local documentation serving and building - Added documentation badge to README.md linking to the GitHub Pages site
- Updated .gitignore to exclude mdBook build artifacts
Reviewed changes
Copilot reviewed 20 out of 22 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/docs.yml |
GitHub Actions workflow for building mdBook and deploying to GitHub Pages |
book/book.toml |
mdBook configuration with site URL, theme settings, and search configuration |
book/src/SUMMARY.md |
Documentation table of contents defining the book structure |
book/src/introduction.md |
Main introduction page with features, performance, and links |
book/src/installation/*.md |
Installation guides for Python, macOS, Rust, and source builds |
book/src/python-api/*.md |
Python API documentation with quickstart and configuration details |
book/src/cli/*.md |
CLI documentation with command reference |
book/src/gui/README.md |
GUI application user guide |
book/src/algorithms/README.md |
Clustering algorithms overview and comparison |
book/src/reference/*.md |
Technical reference including HDF5 schema specification |
book/src/images/logo.svg |
Project logo for documentation |
pyproject.toml |
Added mdBook-related pixi tasks and CLI build tasks |
README.md |
Added documentation badge and updated documentation links |
.gitignore |
Added mdBook build output directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove non-existent Graph algorithm from feature list - Fix min_tot_threshold default: 10 not 0 (matches rustpix-core) - Add mdbook to pixi dependencies for self-contained builds Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix abs_scan_interval default: 100 not 1000 - Fix HitBatch types: x/y are uint16, tof is uint32, timestamp is uint32 - Fix NeutronBatch types: tof is uint32, tot is uint16 - Add notes explaining tof is stored in 25ns ticks (multiply by 25 for ns) - Fix quickstart.md code comments with correct types Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
book/directorybook(serve locally),book-build(build)Documentation Chapters
Next Steps After Merge
Enable GitHub Pages in repo settings:
The docs will be available at:
Closes #121
🤖 Generated with Claude Code