Skip to content

docs: add page title and description conventions for agents - #1694

Merged
comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/frontmatter-conventions
Sep 16, 2026
Merged

comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/frontmatter-conventions

Conversation

@lin-bot23

@lin-bot23 lin-bot23 commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

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.
    • Titles lead with the specific subject: model, tool, or feature name. A bare generic word is not enough.
    • Descriptions: 40 to 160 characters (target 120 to 155), state what the page covers, never duplicate the title, no marketing superlatives, and must be quoted when they contain a colon-space sequence (unquoted colons break frontmatter parsing).
    • Anti-pattern table with before/after fixes and worked examples.
  • AGENTS.md: a summary section pointing at the rules file, so the constraint is visible in the main agent guide.
  • docs-i18n-translate skill: notes that localized titles/descriptions must convey the same scope as English (not word-for-word translation), and that zh/ja/ko frontmatter updates land in the same commit as the EN change.

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.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

  • Run on-demand review

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.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 61516f18-18ca-4ac3-9748-e1f88aa76629

📥 Commits

Reviewing files that changed from the base of the PR and between f8e6fff and 4bca866.

📒 Files selected for processing (3)
  • .cursor/rules/docs-frontmatter.mdc
  • .cursor/skills/docs-i18n-translate/SKILL.md
  • AGENTS.md

Comment @coderabbitai help to get the list of available commands.

@lin-bot23

Copy link
Copy Markdown
Contributor Author

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.

@lin-bot23
lin-bot23 force-pushed the docs/frontmatter-conventions branch from cf9e0d5 to 4bca866 Compare September 16, 2026 10:52
@comfyui-wiki
comfyui-wiki merged commit f75ecd1 into Comfy-Org:main Sep 16, 2026
7 checks passed
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