Skip to content

docs: canonical root AGENTS.md — workspace map, Definition of Done, conventions#356

Merged
blove merged 3 commits into
mainfrom
docs/agents-md
Jul 13, 2026
Merged

docs: canonical root AGENTS.md — workspace map, Definition of Done, conventions#356
blove merged 3 commits into
mainfrom
docs/agents-md

Conversation

@blove

@blove blove commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

A canonical repo-root AGENTS.md — the standards entrypoint for contributors and coding agents, consolidating what previously lived only in dated docs/superpowers/plans/*.

Contents

  • Disambiguation up front — this repo-root file vs the runtime workspace/AGENTS.md capability (packages/core/.../agents-md.ts) that injects an app's memory into the agent prompt. Real name collision; stated first.
  • Workspace map — all 19 packages (+ apps/examples/charts) grouped by role, re-derived from each package.json/README.md (not trusted from the spec).
  • Definition of Done — the exact validate-job gates from .github/workflows/ci.yml, in order, + the changesets gate and the env-flag-gated lanes; pnpm ci:validate approximates it locally.
  • Conventions promoted to first-class — fixed-group changesets→patch, exactOptionalPropertyTypes spreads, never bare biome check --write, src.js/test.ts, gpt-5-family example ids, branch-per-PR + pin-before-parallel-agents, build-before-dist, banned doc phrases, run-from-root.

CONTRIBUTING.md (PR/CLA) and CONTRIBUTORS.md (scaffold-internal path) are kept and cross-linked; CONTRIBUTORS' partial package list now points at the AGENTS.md map so the two can't diverge.

Honesty note: while writing this, the build caught that the "gpt-5-only is enforced by check-docs.mjs" belief is inaccurate — check-docs has no such rule. AGENTS.md documents it as a convention, not currently CI-enforced (a candidate future follow-up to actually enforce).

Docs-only; no packages/** change, so no changeset. check-docs + lint green.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jul 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dawnai Ready Ready Preview, Comment Jul 13, 2026 7:29pm

Request Review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated approval: this PR received an intelligent (AI) code review. See the review comments on this PR.

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Claude finished @blove's task in 0s —— View job


I'll analyze this and get back to you.

@blove
blove merged commit 3ff24de into main Jul 13, 2026
15 checks passed
@blove
blove deleted the docs/agents-md branch July 13, 2026 20:10
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