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

Merged

igor merged 2 commits from agent/471-docs-spruce-up-readme-title-says-agent-identity into master

2026-08-09 01:59:34 +00:00

igor commented

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

Collaborator

What this PR does

docs: rewrite README with current identity and feature list
Retitle to # Igor, rewrite the intro paragraph, point per-repo conventions at AGENTS.md/docs/agents-md-spec.md (CLAUDE.md noted as legacy)
Add a "What it does" list covering issue grind, PR shadow review + rework/adjudication, checkpoint-and-resume, maintenance audits, auto-merge + deploy barrier, SEO/GA reporting, logwatch, and feedback triage
Fix the stale clone URL example (<bot-user>/agent -> <bot-user>/igor) and tighten the prereq list against bin/install.sh (added flock/timeout, noted auth)
Docs index already listed docs/agents-md-spec.md; left as-is
No ## License section added -- no LICENSE file or GPL commit found in history, so #469 hasn't merged yet

Test plan

make test passes
make lint (shellcheck + mdl) passes
No manual verification needed; this is a docs-only change

Closes #471

## What this PR does - [x] docs: rewrite README with current identity and feature list - [x] Retitle to `# Igor`, rewrite the intro paragraph, point per-repo conventions at `AGENTS.md`/`docs/agents-md-spec.md` (`CLAUDE.md` noted as legacy) - [x] Add a "What it does" list covering issue grind, PR shadow review + rework/adjudication, checkpoint-and-resume, maintenance audits, auto-merge + deploy barrier, SEO/GA reporting, logwatch, and feedback triage - [x] Fix the stale clone URL example (`<bot-user>/agent` -> `<bot-user>/igor`) and tighten the prereq list against `bin/install.sh` (added `flock`/`timeout`, noted auth) - [x] Docs index already listed `docs/agents-md-spec.md`; left as-is - [x] No `## License` section added -- no `LICENSE` file or GPL commit found in history, so #469 hasn't merged yet ## Test plan - [x] `make test` passes - [x] `make lint` (shellcheck + mdl) passes - [x] No manual verification needed; this is a docs-only change Closes #471

igor added 1 commit

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

docs: rewrite README with current identity and feature list

Lint / check-sync (pull_request) Successful in 6s

Details

Lint / check-sync (push) Successful in 6s

Details

eb579cdf1c

igor commented

2026-08-09 01:38:07 +00:00

Author

Collaborator

🤖 Review — `COMMENT` (automated)

CI for eb579cdf: success

Docs-only README rewrite (one file, ~60 lines) that retitles to # Igor, adds a "What it does" list, and fixes the stale clone URL. In scope, CI green, checklist matches the diff. Not blocking, but the entire value of this PR is factual accuracy against code I cannot see, so I'm leaving it for a human spot-check rather than approving.

Findings

Unverifiable factual claims (the point of the issue). The linked issue says "every claim in the README must be true of the current code." From the diff alone I can't check any of these; they're worth 60 seconds of a human's eyes:
- cadences: maintenance audits "weekly", SEO/GA "monthly", logwatch "daily"
- rework loop "capped at 3 rounds" (this one is corroborated by the reviewer contract, so likely right)
- checkpoint "up to a bounded number of resumes"
- the audit tool list (npm audit, cargo audit, pip-audit, govulncheck, bundle audit)
- deploy barrier verifying "build SHA + sitemap check"
Install dir vs. repo name (README:~L56). The clone URL was fixed to <bot-user>/igor but the target stays ~/.local/share/agent. That may well be correct (systemd units, $AGENT_HOME, etc.), but deliverable 3 asked to verify the clone path against bin/install.sh as it exists now, and the diff only changed the URL half. Please confirm bin/install.sh still expects ~/.local/share/agent.
Prereq bullet is internally inconsistent (README:~L47). The bullet names binaries (jq curl git flock timeout sqlite3) but the apt command installs packages (... util-linux coreutils sqlite3) — flock/timeout never appear in the command, and util-linux/coreutils never appear in the list. It's technically correct (flock←util-linux, timeout←coreutils) but a stranger reading this for the first time will wonder if the command is missing two packages. Suggest either annotating (flock (util-linux), timeout (coreutils)) or just listing packages.
Deliverable 4 claim is outside the diff. "Docs index already listed docs/agents-md-spec.md; left as-is" is plausible and honestly framed as a no-op, but the docs-index section of the README isn't in the shown hunks, so I can't confirm it. Cheap for the human to eyeball.

Checklist honesty

Clean. Every checked item maps to something visible in the diff, and the two no-op items ("left as-is", "no ## License added") are stated as no-ops rather than dressed up as work — that's the right way to report them.

Tests / CI

Docs-only; no tests expected. CI is success on eb579cd, which covers the make test / make lint claims.


---
<sub>Independent review by the harness on `claude-opus-5` (effort: high). The human reviewer is requested once Igor has reviewed; a human still merges.</sub>
<!-- review sha=eb579cdf1cdce3cd3a7d043d0794bcc12c8c46bd verdict=COMMENT ci=success -->

### 🤖 Review — `COMMENT` _(automated)_ CI for `eb579cdf`: **success** Docs-only README rewrite (one file, ~60 lines) that retitles to `# Igor`, adds a "What it does" list, and fixes the stale clone URL. In scope, CI green, checklist matches the diff. Not blocking, but the entire value of this PR is factual accuracy against code I cannot see, so I'm leaving it for a human spot-check rather than approving. ## Findings - **Unverifiable factual claims (the point of the issue).** The linked issue says "every claim in the README must be true of the current code." From the diff alone I can't check any of these; they're worth 60 seconds of a human's eyes: - cadences: maintenance audits "weekly", SEO/GA "monthly", logwatch "daily" - rework loop "capped at 3 rounds" (this one is corroborated by the reviewer contract, so likely right) - checkpoint "up to a bounded number of resumes" - the audit tool list (`npm audit`, `cargo audit`, `pip-audit`, `govulncheck`, `bundle audit`) - deploy barrier verifying "build SHA + sitemap check" - **Install dir vs. repo name (README:~L56).** The clone URL was fixed to `<bot-user>/igor` but the target stays `~/.local/share/agent`. That may well be correct (systemd units, `$AGENT_HOME`, etc.), but deliverable 3 asked to verify the clone path against `bin/install.sh` as it exists now, and the diff only changed the URL half. Please confirm `bin/install.sh` still expects `~/.local/share/agent`. - **Prereq bullet is internally inconsistent (README:~L47).** The bullet names *binaries* (`jq curl git flock timeout sqlite3`) but the apt command installs *packages* (`... util-linux coreutils sqlite3`) — `flock`/`timeout` never appear in the command, and `util-linux`/`coreutils` never appear in the list. It's technically correct (flock←util-linux, timeout←coreutils) but a stranger reading this for the first time will wonder if the command is missing two packages. Suggest either annotating (`flock` (util-linux), `timeout` (coreutils)) or just listing packages. - **Deliverable 4 claim is outside the diff.** "Docs index already listed `docs/agents-md-spec.md`; left as-is" is plausible and honestly framed as a no-op, but the docs-index section of the README isn't in the shown hunks, so I can't confirm it. Cheap for the human to eyeball. ## Checklist honesty Clean. Every checked item maps to something visible in the diff, and the two no-op items ("left as-is", "no `## License` added") are stated as no-ops rather than dressed up as work — that's the right way to report them. ## Tests / CI Docs-only; no tests expected. CI is `success` on `eb579cd`, which covers the `make test` / `make lint` claims. ``` --- <sub>Independent review by the harness on `claude-opus-5` (effort: high). The human reviewer is requested once Igor has reviewed; a human still merges.</sub>

igor added spent time

2026-08-09 01:38:07 +00:00

44 seconds

igor requested review from joshtronic

2026-08-09 01:38:07 +00:00

igor added 1 commit

2026-08-09 01:58:32 +00:00

Merge branch 'master' into agent/471-docs-spruce-up-readme-title-says-agent-identity

Lint / check-sync (push) Successful in 5s

Details

Lint / check-sync (pull_request) Successful in 5s

Details