Skip to content

docs(agents): consolidate architecture into AGENTS.md + merge discipline + shared read-only allowlist#1471

Merged
xuyushun441-sys merged 1 commit into
mainfrom
docs/agents-md-consolidate-perms
Jun 3, 2026
Merged

docs(agents): consolidate architecture into AGENTS.md + merge discipline + shared read-only allowlist#1471
xuyushun441-sys merged 1 commit into
mainfrom
docs/agents-md-consolidate-perms

Conversation

@xuyushun441-sys
Copy link
Copy Markdown
Contributor

Why

Mirrors the hygiene just applied to the framework repo (framework#1555), adapted to this repo's situation.

This repo had two divergent instruction files: a small AGENTS.md (operational rules + multi-agent discipline) and a large .github/copilot-instructions.md (the 10KB "Lead Architect" doc — tech stack, monorepo topology, JSON protocol, the Commandments, renderer patterns). They didn't reference each other.

The problem: Claude Code reads AGENTS.md / CLAUDE.md, not .github/copilot-instructions.md. So all of the architecture guidance was invisible to Claude Code agents working in this repo — they only saw the 2.8KB operational file.

What

  • Fold .github/copilot-instructions.md into AGENTS.md and delete it. Architecture content preserved: tech-stack constraints (cva/cn, no inline styles), monorepo topology table, JSON UIComponent protocol, the Commandments (incl. the No-Touch zone packages/components/src/ui/**), registry/renderer patterns, MSW/client/upstream-first debug strategy, AI workflow. GitHub Copilot reads AGENTS.md natively, so one file now serves every agent.
  • Multi-agent discipline: prefer one git worktree per task; add the merge-only-after-CI-green / never gh pr merge --auto rule.
  • .claude/settings.json (new, committed/shared): read-only browser/preview observation tools (snapshot / screenshot / list / network / console) derived from recent transcript usage, so parallel agents prompt less. Excludes mutating / arbitrary-exec calls (preview_eval, navigate, click, fill, evaluate_script, agent-browser open/eval) and anything Claude Code already auto-allows. .claude/settings.local.json (per-machine) untouched.

Notes

  • Docs/config only — no changeset required.
  • Verified no workflow/config references the deleted file (the only mention is a historical breadcrumb inside AGENTS.md).

🤖 Generated with Claude Code

…; add merge discipline + shared read-only allowlist

Mirror the framework repo's AGENTS.md hygiene.

- Fold .github/copilot-instructions.md (the 10KB "Lead Architect" doc: tech
  stack, monorepo topology, JSON protocol, the Commandments incl. No-Touch
  zones, renderer patterns, MSW/debug strategy) into AGENTS.md and delete it.
  Rationale: Claude Code reads AGENTS.md/CLAUDE.md, NOT copilot-instructions.md,
  so that architecture guidance was invisible to half the agents working here.
  Copilot reads AGENTS.md natively, so one file now serves every tool.
- Multi-agent discipline: prefer one git worktree per task; add the
  merge-only-after-CI-green / never `gh pr merge --auto` rule (matches
  framework #1555).
- .claude/settings.json (new, committed/shared): read-only browser/preview
  observation tools (snapshot/screenshot/list/network/console) derived from
  recent transcript usage, so parallel agents prompt less. Excludes mutating /
  arbitrary-exec calls (preview_eval, navigate, click, fill, evaluate_script,
  agent-browser open/eval) and anything Claude Code already auto-allows.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

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

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Jun 3, 2026 5:32am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation configuration labels Jun 3, 2026
@xuyushun441-sys xuyushun441-sys merged commit a211acc into main Jun 3, 2026
9 checks passed
@xuyushun441-sys xuyushun441-sys deleted the docs/agents-md-consolidate-perms branch June 3, 2026 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

configuration documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants