Skip to content

Fix and simplify README usage instructions - #86

Merged
verovaleros merged 2 commits into
developmentfrom
docs/readme-usage-fixes
Oct 13, 2026
Merged

verovaleros merged 2 commits into
developmentfrom
docs/readme-usage-fixes

Conversation

@verovaleros

Copy link
Copy Markdown
Member

Summary

The usage instructions in the README and the Docker guide did not match how bin/aip works on development.

  • "Run AIP for a specific day" passed only --start-date. Since --end-date defaults to today, this ran every day from that date until today. The examples now pass both dates, and the default is explained.
  • --end-date and date ranges were not documented.
  • The Docker guide said to edit the _example.csv files and also to copy them first. It now says to copy and then edit the copies, and which file is required.
  • The Docker guide showed debug output for a command that runs without -d. The example command now uses -d.
  • There was no Docker example for running a specific date.
  • The Docker guide said the code is mounted into the container. It is copied into the image.

The setup and usage sections were also rewritten to be shorter and clearer, with the common commands in one table.

Testing

Checked that every command and option in the docs exists in bin/aip --help, bin/aip run-models --help and bin/aip rebuild-kb --help.

@verovaleros
verovaleros marked this pull request as ready for review October 13, 2026 07:57
@verovaleros verovaleros self-assigned this Oct 13, 2026
@verovaleros
verovaleros merged commit eaa9c01 into development Oct 13, 2026
3 checks passed
@verovaleros
verovaleros deleted the docs/readme-usage-fixes branch October 13, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant