Skip to content

docs: condense and verify AGENTS.md - #44

Merged
Bre77 merged 1 commit into
mainfrom
fm/agentsmd-python-teslemetry-stream
Sep 2, 2026
Merged

docs: condense and verify AGENTS.md#44
Bre77 merged 1 commit into
mainfrom
fm/agentsmd-python-teslemetry-stream

Conversation

@Bre77

@Bre77 Bre77 commented Sep 2, 2026

Copy link
Copy Markdown
Member

Intent

  • AGENTS.md had accreted into a flat 18.7KB wall of bullets - hard to scan, and carrying claims nobody had re-checked against the code.
    • Every claim was verified against the current source before being kept; nothing was found stale, so this is a restructure and tighten, not a correction.
    • Reorganised into sections (build/test/release, fields & enums, stream lifecycle, vehicle config, energy sites) so a contributor can jump to the area they're touching.
    • Test-file references, previously scattered as trailing sentences across a dozen bullets, are collapsed into one table.
  • 18,714 → 12,707 bytes (-32%). Removed classes of content: narrative rationale already stated verbatim in code comments (stream.py and vehicle.py are heavily commented), duplicated facts stated in two or three bullets, history phrasing ("used to control this", "no longer exists"), and detail re-derivable from the workflow files.
  • Every "must never"/"must always" contract is preserved verbatim or tighter: the top-level-workflow requirement for PyPI trusted publishing, the env-context parse error, _close_response() vs close(), the sorted-snapshot dispatch order, the id-not-site_id filter on energy_totals, ingest's no-dedup/no-ranking contract, and the stand-in duck-typing requirement.

Docs only - no code changed. All 12 test scripts pass locally.

🤖 Generated with Claude Code

https://claude.ai/code/session_018GNMQ3ZKV6TfQhXKM4AzDu

@Bre77
Bre77 merged commit 0dd97a9 into main Sep 2, 2026
14 checks passed
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