Skip to content

Commit 0afd29e

Browse files
committed
docs: correct the docs rules and label the Prompt Guide previews
Three things the quality layer asserted but the pages did not support. changelog-process said "do not recreate docs/weekly-updates.mdx; that empty public page was retired" while the page exists with a real curated feed. It describes the page as it is: unlisted, reachable by URL and RSS, with versioned notes still in the Changelog. The Related-topics rule read as universal, but three different endings are in use and each is right for its shape — Related topics on task pages, a single Next line through the Prompt Guide's numbered sequence, and nothing on reference and concept pages. The rule now says that, and every section matches it; color-grading gained the Next line it was missing and no longer points at a page this stack retired. The vocabulary previews were 18 DocsVideo players in three unlabelled grids, so a reader saw several near-identical clips with no way to tell smooth from snappy. They are now native muted loops with visible captions, which is what AGENTS.md asks for small preview loops in the first place.
1 parent 3bd8a10 commit 0afd29e

4 files changed

Lines changed: 286 additions & 97 deletions

File tree

docs/AGENTS.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,18 @@ narrated film a reader watches intentionally. A plain `<video>` is only for a
5454
small, muted, autoplaying preview loop inside a visual explanation or Catalog
5555
item. Do not mix native browser controls with the custom player.
5656

57-
**Related topics must be visible content.** Mintlify does not render a
58-
`related:` frontmatter list. Add a final `## Related topics` section with only
59-
the two or three destinations that genuinely help the reader continue.
57+
**End a page by pointing somewhere, and make the pointer visible content.**
58+
Mintlify does not render a `related:` frontmatter list, so a frontmatter key
59+
buys nothing. How the pointer looks depends on the page:
60+
61+
- Task, guide, Studio, and Catalog pages end with a `## Related topics` section
62+
naming the two or three destinations that genuinely help the reader continue.
63+
- Pages in a numbered sequence — the Prompt Guide — end with a single
64+
`*Next: [page] — why*` line instead. A course has one useful destination, and
65+
three competing links break the through-line.
66+
- Reference and concept pages (`/packages`, `/sdk`, `/reference`, `/concepts`)
67+
may end without either. A reader arrives there from one specific question and
68+
leaves the same way; inventing three related links is filler.
6069

6170
### Custom React components
6271

docs/contributing/changelog-process.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ This creates internal editorial drafts:
9999
- `updates/social/2026-06-07.discord.md`
100100
- `updates/social/2026-06-07.x.md`
101101

102-
Review and rewrite the generated files before publishing anything. Social drafts are never posted automatically. Do not recreate or commit `docs/weekly-updates.mdx`; that empty public page was retired.
102+
Review and rewrite the generated files before publishing anything. Social drafts are never posted automatically. Curated highlights from these packets go to [Weekly updates](/weekly-updates), which is unlisted in the sidebar and reachable by URL and RSS; exact versioned release notes stay in the [Changelog](/changelog).
103103

104104
## Writing style
105105

docs/prompting/color-grading.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,5 +207,7 @@ Two caveats worth knowing before you promise a client a ramp:
207207
## Next steps
208208

209209
- [Color Grading guide](/guides/color-grading) — the full contract, every key and bound
210-
- [Media Overlays](/guides/media-overlays) — HUD, flash, light leak, freeze-frame dressing
210+
- [Catalog: overlays and effects](/catalog) — HUD, flash, light leak, freeze-frame dressing
211211
- [VFX and liquid glass](/prompting/vfx-and-liquid-glass) — the canvas-pipeline end of the catalog
212+
213+
*Next: [VFX and liquid glass](/prompting/vfx-and-liquid-glass) — the same grading vocabulary pushed into the canvas pipeline.*

0 commit comments

Comments
 (0)