docs: spruce up README -- title says Agent, identity and feature list are dated #471

New issue

Closed

opened 2026-08-09 01:31:39 +00:00 by igor · 0 comments

igor commented

2026-08-09 01:31:39 +00:00

Collaborator

The README is dated -- it predates the project's identity and several major subsystems, and the repo is about to go public (GPL v3, #469), so it's the first thing strangers will read.

Deliverables

Rewrite README.md (keep it tight -- this is a README, not the architecture doc):

Title + identity: # Igor, not # Agent. One-paragraph intro: Igor is an unattended Claude Code harness -- a 1-minute systemd tick that claims Agent-labeled Forgejo issues, ships PRs, shadow-reviews them, and runs a fleet of scheduled passes. The current "Generic harness" framing stays true; keep the sentence about per-repo conventions but note the per-repo context file is AGENTS.md per docs/agents-md-spec.md (CLAUDE.md is legacy during migration).
A short "what it does" list naming the passes that exist today: issue grind, PR shadow review + rework/adjudication, checkpoint-and-resume, maintenance audits, auto-merge + deploy barrier, SEO/GA reporting, logwatch, feedback triage. One line each, no essays. (Do NOT list the CEO digest as a headline feature -- it is being retired.)
Install section: verify it against docs/setup.md and bin/install.sh as they exist NOW (prereqs, clone path, .env flow) and fix anything stale. The clone URL example says <bot-user>/agent -- the repo is igor.
Docs index: keep the existing links list, add docs/agents-md-spec.md.
Keep the ## License section if #469 has merged by then (don't remove it); if it hasn't, don't add one.

Notes

Accuracy beats completeness: every claim in the README must be true of the current code. When in doubt, check the code, not CLAUDE.md prose.
make test green; make lint (markdownlint) clean if the tool is present.

The README is dated -- it predates the project's identity and several major subsystems, and the repo is about to go public (GPL v3, #469), so it's the first thing strangers will read. ## Deliverables Rewrite `README.md` (keep it tight -- this is a README, not the architecture doc): 1. **Title + identity:** `# Igor`, not `# Agent`. One-paragraph intro: Igor is an unattended Claude Code harness -- a 1-minute systemd tick that claims `Agent`-labeled Forgejo issues, ships PRs, shadow-reviews them, and runs a fleet of scheduled passes. The current "Generic harness" framing stays true; keep the sentence about per-repo conventions but note the per-repo context file is `AGENTS.md` per `docs/agents-md-spec.md` (CLAUDE.md is legacy during migration). 2. **A short "what it does" list** naming the passes that exist today: issue grind, PR shadow review + rework/adjudication, checkpoint-and-resume, maintenance audits, auto-merge + deploy barrier, SEO/GA reporting, logwatch, feedback triage. One line each, no essays. (Do NOT list the CEO digest as a headline feature -- it is being retired.) 3. **Install section:** verify it against `docs/setup.md` and `bin/install.sh` as they exist NOW (prereqs, clone path, `.env` flow) and fix anything stale. The clone URL example says `<bot-user>/agent` -- the repo is `igor`. 4. **Docs index:** keep the existing links list, add `docs/agents-md-spec.md`. 5. Keep the `## License` section if #469 has merged by then (don't remove it); if it hasn't, don't add one. ## Notes - Accuracy beats completeness: every claim in the README must be true of the current code. When in doubt, check the code, not `CLAUDE.md` prose. - `make test` green; `make lint` (markdownlint) clean if the tool is present.

igor added the

Agent

label

2026-08-09 01:31:40 +00:00

igor self-assigned this

2026-08-09 01:33:00 +00:00

igor referenced this issue from a pull request that will close it,

2026-08-09 01:36:31 +00:00

docs: rewrite README with current identity and feature list #472

igor added spent time

2026-08-09 01:36:31 +00:00

3 minutes 18 seconds