You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In README.md (and mirrored text in mkdocs/getting-started.md):
The "Dependencies → Documentation" section is empty (line ~66). List: MkDocs + Material, Ford (optional), Zensical (experimental).
"Each part of the project has its own Makefile which can be invoked directly:" followed by ./fortran/src/Makefile etc. — Makefiles are not executables. Reword to show make -C <dir> <target> only (the correct examples already follow).
Redundant environment setup: uv venv + source .venv/bin/activate + uv sync — uv sync alone creates the venv; activation is unnecessary when commands are run via uv run (as runall and the docs Makefile expect). Simplify to uv sync and mention uv run usage. Apply to both README and getting-started page.
runall options are undocumented: -u (regenerate known-good outputs) and the ABS_TOL/REL_TOL environment variables. Add a short "Updating known good outputs" subsection.
docs/TODO.md items that now have issues should be replaced by links to those issues (or the file trimmed to only untracked ideas), so there is a single source of truth.
Verification
make -C docs html builds cleanly; proofread rendered pages. British English, Oxford comma, plain English.
Problems
In
README.md(and mirrored text inmkdocs/getting-started.md):Makefilewhich can be invoked directly:" followed by./fortran/src/Makefileetc. — Makefiles are not executables. Reword to showmake -C <dir> <target>only (the correct examples already follow).uv venv+source .venv/bin/activate+uv sync—uv syncalone creates the venv; activation is unnecessary when commands are run viauv run(asrunalland the docs Makefile expect). Simplify touv syncand mentionuv runusage. Apply to both README and getting-started page.runalloptions are undocumented:-u(regenerate known-good outputs) and theABS_TOL/REL_TOLenvironment variables. Add a short "Updating known good outputs" subsection.docs/TODO.mditems that now have issues should be replaced by links to those issues (or the file trimmed to only untracked ideas), so there is a single source of truth.Verification
make -C docs htmlbuilds cleanly; proofread rendered pages. British English, Oxford comma, plain English.