docs(repo): add AGENTS.md — page templates, writing style, code-example policy, agent discoverability - #2269
Open
GigaHierz wants to merge 1 commit into
Open
docs(repo): add AGENTS.md — page templates, writing style, code-example policy, agent discoverability#2269GigaHierz wants to merge 1 commit into
GigaHierz wants to merge 1 commit into
Conversation
…ample policy and agent-discoverability rules Refs #2251 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The hole, and the fix
The repo had no written standard: no
AGENTS.md/CLAUDE.mdonmain, a PR template written for application code, and one prose style page (contribute-to-celo/contributors/documentation-contributors.mdx) with six generic rules. The result is visible in the content: 329 Title-Case vs 235 sentence-case H2s, 18 pages still onog:description, three shell and two TypeScript fence aliases in use, 11 pages with>blockquote callouts, and the same numbers stated differently across pages (block time, fee level, stablecoin count, MiniPay reach).This adds
AGENTS.md(155 lines) as the single standard for humans and coding agents, and a one-lineCLAUDE.mdpointing at it. It codifies what the best current pages already do rather than inventing a new style:title+descriptionrequired; neverog:description/id/icon/mode)## Resources+## Relatedclosers, sentence-case headingsBasis: a survey of all 229 non-legacy pages (frontmatter keys, component usage, heading case, link style, fence tags, section names) plus the
CLAUDE.mddraft from PR #2209 ata14395f8.What this does NOT do / residual risk
home/index.mdx:28, fee claims onx402.mdx:184, three different Mento counts, 18og:descriptionpages) stay as they are; the canonical-page table tells editors which value wins. The Sepolia USDC address error is filed separately as bug: Sepolia USDC token address in fee-abstraction tables is the mainnet adapter (no code on Sepolia) #2268..github/PULL_REQUEST_TEMPLATE.md(synced from pm-kit; out of scope here).AGENTS.mdandCLAUDE.mdare parsed bymint broken-linkslike any Markdown file; they are not innavigation, so they do not publish.Judgement calls
<Steps>component even though Mintlify offers it: it is used 0 times in the repo; consistency beats the nicer component. One-line change to allow it.CLAUDE.mdis a pointer file, not a symlink, so it renders on GitHub.Issues
Refs #2251 — closes "AGENTS.md merged" and "CLAUDE.md is a pointer". Still open: "the epic and tab tickets link to it as the acceptance standard" (done after merge, it needs the merged URL).
Stacking / conflicts
Branched off
main, independent of my other open PRs (#2267 touchesdocs.jsononly). No other open PR adds a rootAGENTS.md/CLAUDE.md.Verification evidence
Every internal path named in the canonical-page table exists on
maintoday except/build-on-celo/build-with-ai/self-agent-id, which is added by the Self Agent ID PR (#2262);mint broken-linksdoes not check prose paths inside a.mdtable, so I checked them by hand againstdocs.json. No test seam applies to a guidance file; the enforcement is review against it.Remaining ops steps
AGENTS.mdfrom the epic Epic: Docs restructure — 7 tabs → Learn / Build / Operate / Contribute #2266 and from story: Learn tab — move home/* (plus kept L1 content) to learn/* #2258, story: Build tab — merge "Build on Celo" and Tooling into build/*, with Agents and Mini Apps leading #2259, story: Operate tab — move infra-partners/* to operate/* and fold Specs in as a Specification section #2260, story: Homepage, Contribute rename, and an "AI resources" page — final pass #2261 as the acceptance standardChecklist
mainmint broken-linkspasses on this head