Docs: uv-first install guide, chain-first tutorials, and fixes#463
Open
peterrrock2 wants to merge 8 commits into
Open
Docs: uv-first install guide, chain-first tutorials, and fixes#463peterrrock2 wants to merge 8 commits into
peterrrock2 wants to merge 8 commits into
Conversation
peterrrock2
marked this pull request as draft
July 19, 2026 22:08
peterrrock2
marked this pull request as ready for review
July 19, 2026 22:19
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.
Summary
Major rewrite of the installation guide to give better instruction on how to work with virtual
environments. Changes to the other tutorials were intentionally kept minimal; the
MarkovChainexamples were converted to the incremental "build the chain first" style, but rewording of the
surrounding narrative was limited to what was necessary.
Docs are ready for more serious edits from @chief-dweeb after this. It was faster for me to just
make the minimal changes that I wanted than it was for me to add the notes in.
Brings the user guide in line with the 1.0.0 API and tooling: an installation guide rewritten around
uv, the tutorials converted to the incremental "build the chain first" style, and a set of small doc
and repository fixes. Documentation-only. Stacks on
misc/odds-and-ends-pt2.Why
Three gaps had opened up between the docs and the current library:
python -m venvand contradicted itself once uvguidance was added.
MarkovChainall at once, rather than the incremental paradigmintroduced in
recom.ipynb.gerrychain[geo]extra that no longer exists, and a stalled ReCom chainhad no user-facing explanation.
Changes
docs/user/install.mdaround uv (uv init/uv add,uv run, git installs), keepingpip+python -m venvas the alternative, and added a "Checking Your Installation" section withcopyable preflight checks and a notebook-kernel check.
MarkovChainexamples inquickstart.ipynb,data.ipynb,geometries.ipynb,reproducibility.md, andgenerate_recom_assets.pyto instantiate the chain first and configureit incrementally, with the surrounding narrative rewritten to explain each piece as it is
attached.
recom.ipynbexplaining that a stalledchain means cuttable trees are rare, not impossible.
gerrychain[geo]andgeo_settings.txtinstructions from the README, andgitignored the local
PA_VTDs.jsontutorial copy and thePA_output.jsonlthatdata.ipynbwrites when executed.
Testing
make docs, warnings-as-errors)Ran
make docsandmake docs-test, confirmed committed notebooks carry no outputs, re-executedeach converted notebook into the ignored MyST-NB cache, and ran the install commands and preflight
checks end-to-end in fresh projects across the released, git, and development versions.