docs: Add mdbook user guide with GitHub Pages deployment#2
Merged
Conversation
Comprehensive documentation covering all Reflex features: - Introduction, getting started, building from source - Pipeline viewer, navigation, cursors, undo/redo - Performance counters (sparklines, heatmap, display modes) - Minimap (counter range, pipeline indicator, interactions) - Timeline overlay, queue panels, configuration (TOML presets) - Complete keyboard shortcut reference Also updates README.md with docs link and CLAUDE.md with counter/minimap architecture info. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add docs job to CI that builds mdbook on every push/PR - Add separate docs.yml workflow that deploys to GitHub Pages on push to main - Uses mdbook v0.4.44 binary release for fast CI Co-Authored-By: Claude Opus 4.6 (1M context) <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
Pages
CI Changes
ci.yml: newdocsjob that builds mdbook on every push/PRdocs.yml: new workflow that deploys to GitHub Pages on push to mainSetup Required
After merging, enable GitHub Pages in repo settings:
Settings > Pages > Source: GitHub Actions
Post-Deploy Monitoring & Validation
No additional operational monitoring required: documentation-only change with no runtime impact.
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com