docs: add page title and description conventions for agents - #1694
Conversation
|
Warning Review limit reached
On-demand reviews are free for the next 24 days. After that, they cost $0.25 per reviewed file. Or wait 27 minutes for your next included review. View limit detailsLimit details: You’ve used all 2 included reviews currently available. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (3)
Comment |
|
Note on the failing check-i18n-translations run: the missing-file list is entirely the Comfy Router translation backlog (152 generated code pages x 3 languages, plus the api/headers main pages). Those are being added in #1660, which is still open and CI-green on its own branch. This PR changes only AGENTS.md, .cursor/rules/docs-frontmatter.mdc, and the docs-i18n-translate skill; it neither introduces nor can resolve that backlog. Merging #1660 first will turn this check green here. |
cf9e0d5 to
4bca866
Compare
Summary
Search results, browser tabs, and link previews surface only a page's title and description frontmatter. A large share of our pages currently open with generic names (Overview, Tips, Getting Started) or one-line descriptions, so users scanning search results cannot tell what a page covers before clicking.
This PR adds the conventions to the agent-facing docs so every agent (human or AI) writing or editing MDX pages applies the same rules going forward:
.cursor/rules/docs-frontmatter.mdc(new): the hard rules.AGENTS.md: a summary section pointing at the rules file, so the constraint is visible in the main agent guide.Motivation
The daily SEO audit found ~136 pages with quality gaps (overlong descriptions, short titles, thin content) before the recent cleanup PRs. Root cause: no documented per-page rule list for agents to follow when creating pages. This codifies it.