Skip to content

Agent docs: refresh every AGENTS.md and add six missing ones - #2030

Merged
r3dbars merged 9 commits into
mainfrom
claude/agents-md-refresh
Oct 8, 2026
Merged

r3dbars merged 9 commits into
mainfrom
claude/agents-md-refresh

Conversation

@r3dbars

@r3dbars r3dbars commented Oct 7, 2026

Copy link
Copy Markdown
Owner

Why

The AGENTS.md files had drifted from the code. Several described dictation shortcuts and settings that 1.1.70 removed, and many had grown long with history notes that agents had to read past. A few folders with their own rules (release scripts, CI, Tests, the Live and Companion tools) had no doc at all.

Product Impact

  • Affects: docs only
  • Lane: agent workflow
  • Why this matters: agents start from these docs. Stale or bloated docs lead to wrong edits and wasted context.

What changed

  • Rewrote all 27 existing AGENTS.md files. Every path, type, command and behavior claim was checked against current main. Stale facts were fixed: one Right Option dictation key (hold or tap), no Hands-Free or paste-last hotkey, dictation audio kept 30 days, 15-minute takes, and the "Better matching on calls" setting removed.
  • Kept every rule and known trap. Narrative history, version and issue asides, and duplication of parent docs were cut. Net change is +1,121 / −2,390 lines. The biggest trims were UI (264→50 lines), Core (272→105), Settings (301→129), MCP (251→113) and CLI (233→105).
  • Added six new docs: Tests/, .agents/, .github/, scripts/release/, Tools/TranscriptedLive/ and Tools/TranscriptedCompanion/. Each folder was chosen because it has its own safety or workflow rules. Other folders were looked at and left alone because a README or parent doc already covers them.
  • Registered the new docs in .agents/agent-contract.json, the root AGENTS.md "Start here" step, and docs/repo-layout.md. Also fixed the stale file-size baseline count in repo-layout.md (42 → 37).

Worth a look in review:

  • Two notes were removed as narrative. Restore them if they still guide agents: Speech's "don't assume a separate local-LLM drafting path exists" and UI's "Draft-mode UI is not an active product path".
  • These numbers were carried over from the old docs without being checked again:
    • Speech: 2–3x faster first audio, the 4/2-worker limits and the 1.5 s mis-tap limit.
    • Settings: the Today performance notes.

How I checked it

  • python3 scripts/dev/check-doc-paths.py: OK, 151 Markdown files
  • python3 scripts/dev/check-known-traps.py: all 5 checks ok
  • python3 scripts/dev/agent-context.py on the new doc areas: each resolves to the right area and lists the new docs
  • bash check.sh quick: 66 passed, 0 failed
  • bash build.sh --no-open / bash run-tests.sh

Checks I could not run, and why:

  • Swift build and tests were not run. The change is docs plus one JSON registry, and check.sh quick covers the registry.

🤖 Generated with Claude Code

Rewrite all 27 AGENTS.md files against current code: fix stale paths,
commands and behavior (single Right Option dictation key, 30-day dictation
audio, 15-minute takes, removed call-matching setting), keep every rule and
known trap, and cut narrative history and parent-doc duplication.

Add AGENTS.md for Tests/, .agents/, .github/, scripts/release/,
Tools/TranscriptedLive/ and Tools/TranscriptedCompanion/, and register them
in .agents/agent-contract.json, the root guide and docs/repo-layout.md.
# Conflicts:
#	Sources/Meeting/AGENTS.md
#	Sources/Support/AGENTS.md
#	Sources/TranscriptedCore/AGENTS.md
#	Sources/UI/AGENTS.md
#	Sources/UI/Overlay/AGENTS.md
@r3dbars

r3dbars commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T17:11:59.206392Z 5834419 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

# Conflicts:
#	Sources/Support/AGENTS.md
@r3dbars

r3dbars commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: daae8aef9b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .agents/AGENTS.md Outdated
Comment thread .agents/agent-contract.json Outdated
Comment thread Tools/TranscriptedCompanion/AGENTS.md Outdated
Comment thread Sources/Accessibility/AGENTS.md Outdated
Comment thread Tests/AGENTS.md Outdated
Comment thread Tools/TranscriptedCaptureKit/AGENTS.md Outdated
@r3dbars r3dbars mentioned this pull request Oct 8, 2026
9 tasks
@r3dbars

r3dbars commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: aa73250876

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/AGENTS.md Outdated
Comment thread Tools/SpeakerEvalHarness/AGENTS.md Outdated
Comment thread Tools/TranscriptedQA/AGENTS.md Outdated
@r3dbars r3dbars closed this Oct 8, 2026
@r3dbars r3dbars reopened this Oct 8, 2026
@r3dbars

r3dbars commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

Corrected the nine documentation/owner-routing findings from #2168 in head f4b4845f83d6b44d095dddc354b31cd7cbe687ca, after merging current main without force-pushing.

The eight tool packages now resolve to their own agent guides, with Live/Companion guides limited to their own packages. Documentation now matches current code for census shrink behavior, preview fixture recording ownership, display selection, flaky-test runners, retention choices, SpeakerEvalHarness CI/platform requirements and QA legacy state/log inference. The workflow guide also reflects app-build runner routing and always-mode sweep behavior.

Validation: bash check.sh quick PASS (251 seconds), doc paths PASS (159 documents), agent-context and agent-check self-tests PASS, and direct owner resolution checks PASS for all eight tool packages. Diff whitespace check passed.

The default mapped check selects 48 checks, including forced dependencies and multiple Swift packages, despite this being agent documentation/registry changes. It was stopped to avoid redundant heavy builds; the full union of mapped checks remains pending on the combined integration result. verify-change.sh also selects native checks from AGENTS.md folder paths; no native proof is claimed for this docs repair. Independent full original-PR review remains pending before merge.

Integration note: once #2139 is included, restore the unconditional no-add/no-raise census shrink guarantee in .agents/AGENTS.md; its documented exception is accurate for this head's current census implementation.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f4b4845f83

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .agents/agent-contract.json
Comment thread Tools/TranscriptedLive/AGENTS.md

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 583441962c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .agents/agent-contract.json
Comment thread Sources/UI/MenuBar/AGENTS.md
@r3dbars r3dbars closed this Oct 8, 2026
@r3dbars r3dbars reopened this Oct 8, 2026
@r3dbars
r3dbars merged commit fbaed0d into main Oct 8, 2026
16 of 26 checks passed
@r3dbars
r3dbars deleted the claude/agents-md-refresh branch October 8, 2026 18:34
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