Skip to content

Simplify the README synopsis; add development docs and AGENTS.md - #21

Merged
springwq merged 2 commits into
mainfrom
codex/readme-docs-cleanup
Aug 22, 2026
Merged

Simplify the README synopsis; add development docs and AGENTS.md#21
springwq merged 2 commits into
mainfrom
codex/readme-docs-cleanup

Conversation

@springwq

@springwq springwq commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

https://github.com/feed-mob/tracking_admin/issues/22898

  • Drop the per-command `[--json]` from the README synopsis — it is documented in the JSON output section.
  • Add `docs/development.md` (setup, tests/lint, layout, release pointer) and link it from the README.
  • Add `AGENTS.md` with verification commands, project conventions, and hard security rules for coding agents.

`docs/` in git now holds only process docs: development, release, and the release plan record. (`docs/superpowers/` is git-ignored local material.)

springwq and others added 2 commits August 22, 2026 19:59
--json is documented in the JSON output section; repeating it on every
synopsis line is noise.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
docs/development.md covers setup, testing, and layout; AGENTS.md gives
coding agents the verification commands, conventions, and the security
rules this project requires.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@springwq springwq changed the title Simplify the command synopsis in the README Simplify the README synopsis; add development docs and AGENTS.md Aug 22, 2026
@springwq
springwq merged commit 810b733 into main Aug 22, 2026
7 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