From 174bd4e2dcdc4a9da1467892d3a3ca4d7f96c74a Mon Sep 17 00:00:00 2001 From: ukimsanov Date: Mon, 3 Aug 2026 16:15:28 -0700 Subject: [PATCH] docs: add documentation quality gates --- docs/AGENTS.md | 98 ++++++ docs/contributing.mdx | 193 +++-------- docs/contributing/catalog.mdx | 302 ++++++----------- docs/contributing/changelog-process.mdx | 12 +- .../studio-manual-dom-editing.mdx | 315 ------------------ docs/contributing/testing-local-changes.mdx | 123 +++---- docs/prompting/anatomy.mdx | 14 +- docs/prompting/capstone.mdx | 14 +- docs/prompting/captions-and-talking-heads.mdx | 9 +- docs/prompting/captions-catalog.mdx | 27 +- docs/prompting/code-and-prs.mdx | 16 +- docs/prompting/code-blocks.mdx | 38 ++- docs/prompting/color-grading.mdx | 62 +++- docs/prompting/data-and-maps.mdx | 38 ++- docs/prompting/design-systems.mdx | 8 +- docs/prompting/editing-existing-videos.mdx | 24 +- docs/prompting/examples.mdx | 130 +++++++- docs/prompting/explainers.mdx | 15 +- docs/prompting/generated-artwork.mdx | 20 +- docs/prompting/media-and-audio.mdx | 14 +- docs/prompting/motion-graphics.mdx | 8 +- docs/prompting/motion.mdx | 74 +++- docs/prompting/music-and-slideshows.mdx | 14 +- docs/prompting/overlays-and-lower-thirds.mdx | 27 +- docs/prompting/overview.mdx | 26 +- docs/prompting/product-launch.mdx | 14 +- docs/prompting/recreating-references.mdx | 9 +- docs/prompting/rendering-and-output.mdx | 15 +- docs/prompting/runtimes-and-3d.mdx | 20 +- docs/prompting/storyboards.mdx | 16 +- docs/prompting/transitions.mdx | 14 +- docs/prompting/variables-and-templating.mdx | 14 +- docs/prompting/vfx-and-liquid-glass.mdx | 32 +- docs/prompting/visual-specs.mdx | 20 +- docs/prompting/vocabulary.mdx | 110 +++++- 35 files changed, 1003 insertions(+), 882 deletions(-) create mode 100644 docs/AGENTS.md delete mode 100644 docs/contributing/studio-manual-dom-editing.mdx diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 000000000..925b7ab30 --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,98 @@ +# HyperFrames documentation rules + +Before changing a page, read its complete body and verify product behavior in +the current source, tests, CLI help, or shipped skills. + +- Write for a smart general user first. Do not assume they are a developer. +- Explain what a person can accomplish before explaining implementation details. +- Prefer plain words, short examples, screenshots, and visible outcomes. +- Keep agent instructions copyable and specific. +- Put CLI, SDK, package, schema, deployment, and internals under **Developers**. +- Never infer product behavior from page titles or old docs. Verify it in current code. +- Do not preserve a page merely because it already exists. Merge, rewrite, redirect, or remove it when that improves the user journey. +- Do not publish empty, duplicated, outdated, or aspirational content as fact. +- A page should answer a real question or help complete a real task. +- Preserve the approved Mintlify header, sidebar, right-side contents, and page-width behavior unless a task explicitly changes the site chrome. + +## Page standard + +Most human-facing pages should contain: + +1. What this lets you do +2. When to use it +3. A visual or concrete example +4. The shortest successful path +5. What should happen +6. Common problems +7. Useful next steps + +Do not force this structure where it makes a page worse. Reference pages may stay reference-shaped. + +## Component doctrine + +One component per job. If two components on a page render the same list, delete one. + +| The job | Use | Never use | +| --- | --- | --- | +| Choose between destinations | `CardGroup` + `Card`, max 2 columns, linking to the real page | An accordion, or cards pointing at anchors on the same page | +| Ordered instructions | `Steps` | A flow diagram that repeats the same steps | +| Parallel variants of one instruction (source type, OS, language) | `Tabs` | Repeating the whole block per variant | +| Compare attributes across items | A table | Prose paragraphs per item | +| Static image | `Frame` with a caption that says what it is | A bare `img` with no context | +| Genuinely out-of-band aside | One `Note`, `Tip`, or `Warning` per page | Stacked callouts, or a callout for ordinary prose | + +**Do not use accordions for journeys, choices, instructions, or troubleshooting.** They hide the thing the reader needs, cost a click, and weaken `Cmd+F`, printing, and deep linking. A dense optional reference or example gallery may keep accordions when showing every item at once would make the page unusable; the Prompt Guide's verified-example gallery is the existing exception. Long symptom or task lists become visible `##` sections instead — they get anchors the support team can link directly, and they appear in the page contents. + +**No diagram that restates adjacent prose.** A four-node flow beside a four-step list is the same content twice. Keep whichever is more useful and delete the other. + +**Cards link to pages, never to anchors on the current page.** A card that scrolls the reader a short distance to the same words is the worst pattern in these docs; it has been removed twice. + +**Two columns is the practical maximum** for anything containing text. Three columns in this content width hyphenates titles mid-word. + +**Full films and preview loops are different jobs.** Use `DocsVideo` for a +narrated film a reader watches intentionally. A plain `