Skip to content

Audit and shrink AGENTS.md (#341) - #376

Merged
obj-p merged 1 commit into
mainfrom
341-agents-md-audit
Jul 11, 2026
Merged

Audit and shrink AGENTS.md (#341)#376
obj-p merged 1 commit into
mainfrom
341-agents-md-audit

Conversation

@obj-p

@obj-p obj-p commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Closes #341.

Shrinks AGENTS.md from ~6.9k to ~4.0k estimated tokens (42% cut, wc -c / 4), weighting the remaining content toward the build/test/merge workflow and test craft, and dropping the ~half that duplicated README (install, CLI usage, --json, traits, variants, multi-preview, setup plugin, touch injection → now a pointer to README.md).

Four stale claims fixed

  • SwiftPM coverage. Post-Add a hermetic Bazel build alongside SwiftPM #246 Package.swift publishes only PreviewsSetupKit, so swift build / swift test compile a near-empty package and pass without exercising changed code — a false positive. Replaced the "same coverage / swift test fallback" advice, and swept the stray swift build (daemon-staleness) and .build/... (worktree) mentions, with the real Bazel build+test+lint reality.
  • .mcp.json location. Was "parent directory"; it is at the repo root. Fixed, and noted it is what Claude Code auto-spawns the stdio server from (what mcp__previewsmcp__* and the integration-test skill reach).
  • "CI-specific concerns" section. Moved the three load-bearing bullets under Test architecture (per-target socket dir Derive test daemon socket dir from $TEST_TMPDIR instead of hand-allocated /tmp literals #283, bidirectional MCP-ping liveness, MCPTestServer pthread watchdog) and deleted the CI-runner-specific bullets. Kept the window-server / CGMainDisplayID()==0 hang hint as a real debugging lever.
  • Merge gate (previously described twice, neither complete) consolidated into one checklist: /simplify + /code-review per chunk → lint:check → full local suite (no CI) → classify failures ours-vs-preexisting → stage explicit paths → un-draft → squash-merge.

Scope / verification

  • Docs-only diff (markdown), no runtime surface — unit/integration suites N/A.
  • bazel run //tools/lint:check clean (exit 0; remaining warnings are pre-existing in untouched source files).
  • No comment-policy section added — that is sequenced under Sweep verbose comments; codify a self-documenting-code comment policy in AGENTS.md #365, after this lands.
  • .mcp.json retained (keep/remove is being arbitrated separately); this PR only fixes its documented location.

🤖 Generated with Claude Code

@obj-p
obj-p force-pushed the 341-agents-md-audit branch from f8d9ebb to 9c9642e Compare July 11, 2026 12:32
Cut ~40% (6.9k→4.0k est. tokens), weighting toward build/test/merge
workflow and test craft, and dropping content that duplicated README.

Fix four stale claims:
- SwiftPM: Package.swift only publishes PreviewsSetupKit, so `swift
  build`/`swift test` are false positives. Replace the "same coverage /
  swift test fallback" advice (and the stray `.build`/`swift build`
  mentions) with Bazel build+test+lint reality.
- .mcp.json is at the repo root, not a "parent directory".
- Move the load-bearing bullets out of "CI-specific concerns" into Test
  architecture (per-target socket dir #283, bidirectional MCP-ping
  liveness, MCPTestServer pthread watchdog) and drop the dead
  CI-runner bullets. Keep the window-server / CGMainDisplayID hint.
- Consolidate the twice-described merge gate into one checklist.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@obj-p
obj-p force-pushed the 341-agents-md-audit branch from 9c9642e to d07b48d Compare July 11, 2026 12:38
@obj-p
obj-p merged commit e45c655 into main Jul 11, 2026
1 of 2 checks passed
@obj-p
obj-p deleted the 341-agents-md-audit branch July 11, 2026 14:26
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.

AGENTS.md audit: trim to workflow/gates, fix stale claims; decide .mcp.json removal

1 participant