docs(agents): edit canonical specs in place, no divergence notes (PP-00s)#1281
docs(agents): edit canonical specs in place, no divergence notes (PP-00s)#1281timothyfroehlich wants to merge 6 commits intomainfrom
Conversation
…00s) Adds a "Keeping specs aligned" subsection to AGENTS.md section 5 instructing agents to edit canonical spec docs in place rather than appending divergence notes at the bottom of files. Codifies the lesson from PR #1270 review churn where spec/implementation drift produced repeated Copilot back-and-forth. Also tells agents that finding an existing divergence note is a signal to fold the content back into the canonical text, not preserve the annotation. No automation — process guidance only. Single source of truth = the spec docs themselves. Refs PP-2on (epic). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
There was a problem hiding this comment.
Pull request overview
This is a docs/process-only PR that updates AGENTS.md so agent-facing guidance pushes spec maintenance toward in-place edits instead of accumulating implementation-divergence notes.
Changes:
- Adds a new Keeping specs aligned subsection under the documentation philosophy section.
- Instructs agents to update relevant UI/spec documents directly instead of appending drift/disclaimer notes.
- Adds follow-up guidance to fold existing divergence notes back into canonical text.
|
…ionale (PP-00s) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
| `.agent/skills/pinpoint-design-bible/SKILL.md` and archetype docs under | ||
| `.agent/skills/pinpoint-design-bible/archetypes/` — **edit those documents in place**. | ||
| Do not append a "divergence note", "TODO: spec out of date", or end-of-file disclaimer | ||
| describing how the implementation now differs. |
There was a problem hiding this comment.
Fixed in commit fad03f8 — pointed to SKILL.md and noted that archetypes are sections within (§5 and §17). Thanks for catching the dead path. —Claude
…(PP-00s) The previous text referenced a non-existent .agent/skills/pinpoint-design-bible/archetypes/ directory. Page and Modal Archetypes are sections inside SKILL.md (§5 and §17).
Summary
Process guidance only — no automation, no code changes.
Inherited CI failures
mainis currently red. Inherited failures from main (PP-q9r/PP-e20/PP-jsh/PP-v7g/PP-49m) will appear in CI; not introduced by this PR. See Tim's status comment on PR #1278.Test plan
pnpm run checkpasses (1013 unit tests)Related
🤖 Generated with Claude Code