MIL-004: Add README and verify setup #26

Merged
Tirsvad merged 1 commits from mil-004-readme-and-api-docs into main 2026-10-28 09:28:24 +01:00
Owner

MIL-004 README and API docs: README.md built from the framework template (all sections, in order) with the seven lecture step screenshots, instructions to create and use a local .venv, python -m pip install --upgrade pip, run, tests, the Docker end to end run and the Doxygen build.

Verified in a fresh .venv made by following the README: pip install -e ".[dev]", pytest 10 passed, ruff and mypy clean, scraping-wiki --help works, doxygen Doxyfile builds with no warnings. check-readme.sh finds nothing in this README; its one finding is in the framework's own README (it does not name qc-project-plan.md), which is upstream and not edited here (AGENTS.md rule 5).

Closes #15
Closes #16
Closes #17

MIL-004 README and API docs: `README.md` built from the framework template (all sections, in order) with the seven lecture step screenshots, instructions to create and use a local `.venv`, `python -m pip install --upgrade pip`, run, tests, the Docker end to end run and the Doxygen build. Verified in a fresh `.venv` made by following the README: `pip install -e ".[dev]"`, `pytest` 10 passed, `ruff` and `mypy` clean, `scraping-wiki --help` works, `doxygen Doxyfile` builds with no warnings. `check-readme.sh` finds nothing in this README; its one finding is in the framework's own README (it does not name `qc-project-plan.md`), which is upstream and not edited here (AGENTS.md rule 5). Closes #15 Closes #16 Closes #17
Tirsvad added 1 commit 2026-10-28 09:28:22 +01:00
Tirsvad merged commit c7674570f9 into main 2026-10-28 09:28:24 +01:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Tirsvad-Udemy-100-days-of-code/048-scrapping-wiki#26