ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-01 19:42:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct the docs rules and label the Prompt Guide previews

Browse Source 
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.
This commit is contained in:
ukimsanov
2026-08-04 03:06:58 -07:00
parent 174bd4e2dc
commit fd90fd3e72
4 changed files with 286 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing/changelog-process.mdx
+1 -1
View File
@@ -99,7 +99,7 @@ This creates internal editorial drafts:
- `updates/social/2026-06-07.discord.md`
- `updates/social/2026-06-07.x.md`
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.
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).
## Writing style