Fix README: broken docs-build command, broken link, typos, stale content - #410
Open
animmosmith wants to merge 4 commits into
Open
Fix README: broken docs-build command, broken link, typos, stale content#410animmosmith wants to merge 4 commits into
animmosmith wants to merge 4 commits into
Conversation
4 tasks
animmosmith
added a commit
that referenced
this pull request
Jul 31, 2026
5 tasks
Fixes #409. - "Build docs locally" was broken outright: the documented sphinx-apidoc command referenced docs/source and docs/build, neither of which exist. Verified against .readthedocs.yaml and confirmed the correct, working command is a single sphinx-build call (sphinx.ext.autosummary, already configured in docs/conf.py, generates the API docs automatically). - Fixed a broken markdown link (brackets/parens were swapped) and a Windows-style backslash path inside a bash command. - Fixed typos (regester, monatge, complie, awarenes, plesant, aknowledged) and inconsistent "PyOpia"/"PyOPIA" naming throughout. - Replaced the "Development targets" section, which had become stale and in places directly contradicted the current architecture (e.g. it said "no use of settings/config files," but the whole pipeline is config-driven), with a short, accurate "Design principles" section. - Clarified step 5's montage.png as an output file, not a command, and noted that init-project --example-data both downloads images and generates config.toml, so it doesn't appear to come from nowhere. - Expanded the Docker rationale beyond "for users who prefer not to install dependencies directly." Verified the full quick-start flow (init-project, process, merge-mfdata, make-montage) end-to-end with real example data. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
animmosmith
force-pushed
the
409-readme-audit-fixes
branch
from
August 5, 2026 10:07
e52e87a to
fbade52
Compare
…o 409-readme-audit-fixes
…o 409-readme-audit-fixes
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
Fixes #409.
sphinx-apidoc -f -o docs/source docs/build --separatefails immediately since neitherdocs/sourcenordocs/buildexist. Cross-checked.readthedocs.yaml(which builds viadocs/conf.pydirectly) and confirmed the correct, working command is a singlesphinx-build -b html docs/ docs/_build/html- no separate apidoc step needed, sincesphinx.ext.autosummary(already configured indocs/conf.py) generates the API docs automatically.(uv)[url]→[uv](url)) and a Windows-style backslash path inside abashcommand block.Pipelineis config-driven) - with a short, accurate "Design principles" section.montage.pngas an output file rather than a command, and noted thatinit-project --example-databoth downloads images and generatesconfig.toml, so it doesn't appear to come from nowhere.Test plan
init-project --example-data→process→merge-mfdata→make-montage(including the corrected forward-slash path) → confirmedmontage.pngis produced🤖 Generated with Claude Code