docs: consolidate AGENTS.md to current architecture + roadmap wave-3 status#81
Merged
Conversation
AGENTS.md predated the current design. Refresh it to describe reality: - Project structure: the real cli/ package + the http/transport/compat/ client/models/ensure/config/doctor modules; tests/unit vs integration. - New 'Architecture (current layering)' section: CLI -> library -> http.py/ transport -> high-level (MoodleClient/models/doctor) -> ensure-style API, with the rule that HTTP goes through http.py and output through cli/output.py (--output/--fields/--quiet/--verbose/--debug, redaction). - Testing: replace the stale sandbox-based guidance with the unit (tests/unit, mocked, every push) vs integration (--integration, Dockerized erseco/alpine-moodle, 4.5.5/5.0.1/5.1.5) split, the shared create_temporary_course fixture rule, the login warmup, and which CI gates are reliable. - Fix commands/ -> cli/ references and the multi-environment .env convention (MOODLE_<ENV>_URL/USERNAME/PASSWORD, --env local|staging|prod). Also update docs/roadmap-plan.md's progress section: Subtask 14 (py.typed, #78/#79) and Subtasks 18-20 (ensure-* API, #77/#80) are now done.
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
1 participant
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
Documentation consolidation closing out wave 3 (#65). Brings AGENTS.md in line with the current architecture (it predated most of it), and marks the wave-3 subtasks done in the roadmap.
Changes
cli/package and thehttp.py/transport//compat.py/client.py/models.py/ensure.py/config.py/doctor.pymodules, plus thetests/unitvs integration layout.http.py/transport → high-level (MoodleClient/typedmodels/doctor) → the idempotent ensure-style API — with the rules that all HTTP goes throughhttp.py(timeouts, bounded GET-only retry, redaction,--debugtracing) and all output throughcli/output.py(--output/--fields/--quiet/--verbose/--debug).--integration, Dockerizederseco/alpine-moodle, Moodle 4.5.5/5.0.1/5.1.5) split, the sharedcreate_temporary_coursefixture rule, the login warmup, and which CI gates are reliable.commands/→cli/references and the multi-environment.envconvention (MOODLE_<ENV>_URL/USERNAME/PASSWORD,--env local|staging|prod).Test plan
Docs-only; no code changed.
pytest tests/unitandflake8still green; markdown fences balanced. ThedocsCI job validates the build.Notes for reviewers
This is the final wave-3 item for #65 (tracking issue), which I'll close once this and the wave-3 feature PRs (#79, #80, both merged) are in.