Add AGENTS.md and document docs conventions in CONTRIBUTING and STYLEGUIDE#3385
Merged
Conversation
…GUIDE Add agent guidance and write down conventions that previously weren't documented anywhere, so reviewers (human or agent) can check against them. - Add AGENTS.md (tool-neutral agent entry point) and CLAUDE.md (one-line @AGENTS.md import) covering secrets, the invalid-sdk hard failure, the build/lint verify step, a repo map, and pointers to the human docs - CONTRIBUTING: rewrite "Validating your changes" (drop the dead check-links.mjs reference, add build:tsx, the hard-fail vs warning split, and the stale-PR hazard); correct the title/description required-vs-optional severity; add "Authoring SDK code examples" and "Documenting a new feature or reference" subsections - STYLEGUIDE: capitalize Clerk feature proper nouns (e.g. "Agent Tasks") - Fix pre-existing broken ./docs and ./styleguides links in CONTRIBUTING (the file lives in contributing/, so they needed ../ paths) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
I think these are good additions and starting points - thanks for conjuring these up! I left a few comments :) |
Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
…ript - Remove the redundant frontmatter-precision bullet and the duplicative closing beta caveat from the "Documenting a new feature or reference" section in CONTRIBUTING (both restated guidance already stated elsewhere) - Link the clerk/javascript repo reference in AGENTS.md Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
clerk-docs documents APIs and SDKs it doesn't own, so content can be syntactically valid yet factually wrong — and build:tsx/lint won't catch it. - AGENTS.md: add a "Verifying technical claims" section naming the sources of truth (clerk/clerk_go for API behavior/endpoints/versions/ OpenAPI, clerk/javascript for SDK signatures, clerk/clerk for how the docs/reference render); verify against source, not memory, and don't defer checkable facts to the PR author - CONTRIBUTING.md: one-line pointer to that section from "Validating your changes" (depth stays in AGENTS.md, no duplication) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The File metadata intro said "a few required frontmatter fields," which contradicted the clarification just below it that only `title` is required and `description` only warns. Drop "a few required." Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
alexisintech
approved these changes
May 22, 2026
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
2 participants
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.
🔎 Previews:
AGENTS.md,CLAUDE.md,contributing/CONTRIBUTING.md, andstyleguides/STYLEGUIDE.md— none of which are published under/docs.What does this solve? What changed?
Some conventions a contributor (or AI agent) needs aren't written down anywhere, so nothing — human or agent — could check against them. #3176 ("feat: Agent Tasks") shipped a production build failure plus several convention gaps that follow-up #3383 had to clean up. This PR records those conventions and adds agent guidance.
AGENTS.md(tool-neutral agent entry point) andCLAUDE.md(a one-line@AGENTS.mdimport).AGENTS.mdleads with what surprises agents: never read secrets; an invalidsdk:frontmatter value is a hard build failure; runpnpm run build:tsx+pnpm run lintbefore declaring work done; a repo map; and pointers to the human docs. It carries terse operational rules and routes to CONTRIBUTING/STYLEGUIDE for depth, so no rule is duplicated.CONTRIBUTING.mdcheck-links.mjsreference (the file no longer exists), addedpnpm run build:tsx, explained the hard-fail vs warning split (invalidsdk/missingtitlefail the build; missingdescription, a doc not inmanifest.json, and broken internal links only warn), and added a stale-PR rebase hazard.titlereads as required anddescriptionas recommended but only a warning when missing.create-user.mdx/delete-user.mdxpartials per SDK; the build never executes code blocks) and "Documenting a new feature or reference" (beta callout partial +(Beta)tag, hand-authored type pages, required-vs-optional frontmatter precision)../docs/…,./styleguides/…→../…); the file lives incontributing/, so the old paths resolved to the wrong place.STYLEGUIDE.md: added "Capitalize Clerk feature proper nouns" (e.g. "Agent Tasks") as an extension of the existing Next.js proper-noun rule.Verified locally:
pnpm run build:tsx(exit 0) andpnpm run lint(exit 0).Deadline
Other resources