You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
No AGENTS.md or CLAUDE.md exists on main (ls CLAUDE.md AGENTS.md → both "No such file"). Create AGENTS.md at the repo root as the single standard for humans and coding agents, so the restructure PRs and every future page follow one shape and we stop rewriting the same pages.
Must cover
Mintlify workflow:mint dev, mint broken-links; CI runs npx mintlify broken-links on every PR to main (.github/workflows/docs-validation.yml).
The mandatory move checklist (never move a page without all four): add a redirects entry in docs.json → update navigation → update inbound internal links → run mint broken-links.
Page template per page type (concept / guide / reference / notice): required frontmatter (description, not og:description, on non-legacy pages — see Migrate frontmatter og:description to description on non-legacy pages #2239), heading order, where "Prerequisites", "Troubleshooting" and "Next steps" go.
Audience first: the first paragraph says who the page is for (end user / app developer / node operator / contributor).
Writing style: plain English, active voice, present tense; document current behaviour, no history narration in page bodies (that belongs in Notices); never invent technical details (addresses, flags, endpoints) — research or say you don't know; no inflated adjectives.
Code-example policy (decided): keep examples that resolve edge cases an agent or developer cannot derive from the SDK docs — e.g. paying gas in USDC, adapter address vs token address, 6 vs 18 decimals, the feeCurrency parameter per SDK. Drop large end-to-end examples. Every example that remains must run, and the PR that adds it notes the command and output.
Callouts:<Info>, <Note>, <Warning>, <Tip> — not blockquotes.
Prior art
CLAUDE.md in PR #2209 at a14395f8926eb43424e0d20e6d67ab96f2c8209b covers the workflow, repo layout, move checklist and writing style — reuse it. Its "Active work" section (which points at RESTRUCTURE_PLAN.md) should instead link to the epic #2266.
Definition of done
AGENTS.md merged at repo root
CLAUDE.md exists as a one-line pointer to AGENTS.md (or a symlink), so both tool conventions resolve to the same file
Part of #2266.
What needs to be done?
No
AGENTS.mdorCLAUDE.mdexists on main (ls CLAUDE.md AGENTS.md→ both "No such file"). CreateAGENTS.mdat the repo root as the single standard for humans and coding agents, so the restructure PRs and every future page follow one shape and we stop rewriting the same pages.Must cover
mint dev,mint broken-links; CI runsnpx mintlify broken-linkson every PR to main (.github/workflows/docs-validation.yml).redirectsentry indocs.json→ updatenavigation→ update inbound internal links → runmint broken-links.description, notog:description, on non-legacy pages — see Migrate frontmatter og:description to description on non-legacy pages #2239), heading order, where "Prerequisites", "Troubleshooting" and "Next steps" go.feeCurrencyparameter per SDK. Drop large end-to-end examples. Every example that remains must run, and the PR that adds it notes the command and output.<Info>,<Note>,<Warning>,<Tip>— not blockquotes.Prior art
CLAUDE.mdin PR #2209 ata14395f8926eb43424e0d20e6d67ab96f2c8209bcovers the workflow, repo layout, move checklist and writing style — reuse it. Its "Active work" section (which points atRESTRUCTURE_PLAN.md) should instead link to the epic #2266.Definition of done
AGENTS.mdmerged at repo rootCLAUDE.mdexists as a one-line pointer toAGENTS.md(or a symlink), so both tool conventions resolve to the same fileNon-goals
Rewriting existing pages to match — that happens inside the tab moves and the content tickets.
Depends on / blocks
No dependencies. Should land before #2258, #2259, #2260, #2264 so the moves follow it.
Measured at:
bdf40b37