Skip to content

docs: restructure AGENTS.md into a contract over .agents/ pages - #388

Merged
antfu merged 1 commit into
mainfrom
docs/agents-contract
Sep 14, 2026
Merged

antfu merged 1 commit into
mainfrom
docs/agents-contract

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Restructures the 228-line AGENTS.md into a lean maintainer contract in the style of unjs/jup's AGENTS.md, with the detail split into nine numbered pages under .agents/.

  • AGENTS.md now states the everywhere-rules (RFC 2119 keyword meanings, terminology, event maps, DF diagnostics, validator neutrality, catalogs, PR gates), the boundary invariants (devframe/hub layering, mount paths, kit subpath parity, reference-host parity, design tokens), and a task → page routing table.
  • .agents/01-09 carry the full content of the previous guide - positioning, terminology, stack & commands, code conventions, framework kits, design system, hub example parity, diagnostics, docs style - tightened into contract language with MUST/MUST NOT/SHOULD/MAY marking the real invariants. No rule was dropped or invented.
  • CLAUDE.md remains a symlink to AGENTS.md and follows automatically.

Created with the help of an agent.

@coldtea-pr-lens

coldtea-pr-lens Bot commented Sep 14, 2026

Copy link
Copy Markdown

◈ PR Lens

🟢 +1 new · 🟠 ~1 changed · 🔴 -0 removed · 0 flows · 10 files · commit 92f9346


Architecture

Architecture diagram for devframes/devframe at 92f9346

2 components touched across 3 lanes.

Open the interactive canvas


Inside the changed components — 1 view

Component view — Agent Guides

The modular topic guides and root index governing repository development

Architecture view of Component view — Agent Guides in devframes/devframe

Data flow

No data-flow sequence changed in this PR.


View

  • Architecture lens
  • Data flow lens
  • Expand every detail

Tip

Add .github/workflows/pr-lens.yml with coldteadotai/pr-lens/packages/action@v0 and your model provider's key as its api-key to run PR Lens from your own CI. Any /chat/completions endpoint works.

🪧 More tips
  • Run npx skills add coldteadotai/pr-lens, then tell your coding agent: "Diagram the change you just made with PR Lens and attach it to the pull request."
  • Run npx @coldtea/pr-lens-cli analyze --base origin/main on a branch, then npx @coldtea/pr-lens-cli render .pr-lens/graph.json. Same lenses, your own model key, before the pull request exists.
  • Untick Architecture lens or Data flow lens under View to hide a diagram, or tick Expand every detail to open every section. The comment redraws in a few seconds.
  • Click the link under each diagram to open it on a canvas you can zoom, pan and step through.
  • The diagrams are links. Click one to open it on the canvas, then press W or click play to walk through the change.
  • Open a diagram on the canvas, then press W or click play to walk through the change one step at a time.
  • The CLI's render reads .github/pr-lens.yml and applies your renames, exclusions and lane pins at draw time.
  • Set github.comment.collapsed: true in .github/pr-lens.yml to fold the comment behind one View architecture and data flow row. Drawing still runs on every push.
  • Push a commit and the comment redraws for the new head. A slow older run never overwrites a newer one.
  • Switch GitHub to dark mode and the diagrams follow. The moving dots are this pull request's data in motion.

Thanks for using PR Lens! It's built by Coldtea, free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

@vercel

vercel Bot commented Sep 14, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
devframe Ready Ready Preview Sep 14, 2026 5:55am UTC

@antfu
antfu merged commit c8e43f1 into main Sep 14, 2026
7 of 14 checks passed
@antfu
antfu deleted the docs/agents-contract branch September 14, 2026 06:01
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.

2 participants