Audit of README.md found several issues. Most notably, the "Build docs locally" instructions are broken (verified by running them - the referenced folders don't exist); the correct command is a single sphinx-build -b html docs/ docs/_build/html. There's also a broken markdown link, a stray Windows-style path in a bash command, several typos, and inconsistent "PyOpia"/"PyOPIA" naming.
The "Development targets" section is stale and in places contradicts the current codebase (e.g. it says "no use of settings/config files," but the whole pipeline is now config-driven) - worth trimming or rewriting.
Also proposing a few small, concise additions for new-user clarity: a one-line "what is this" intro, a note on where config.toml comes from in the quick-start, and a slightly fuller explanation of why Docker is offered.
Audit of README.md found several issues. Most notably, the "Build docs locally" instructions are broken (verified by running them - the referenced folders don't exist); the correct command is a single
sphinx-build -b html docs/ docs/_build/html. There's also a broken markdown link, a stray Windows-style path in a bash command, several typos, and inconsistent "PyOpia"/"PyOPIA" naming.The "Development targets" section is stale and in places contradicts the current codebase (e.g. it says "no use of settings/config files," but the whole pipeline is now config-driven) - worth trimming or rewriting.
Also proposing a few small, concise additions for new-user clarity: a one-line "what is this" intro, a note on where
config.tomlcomes from in the quick-start, and a slightly fuller explanation of why Docker is offered.