docs(contributing): refresh the catalog contribution guide - #2954
Merged
Conversation
The guide still described a 52-block registry, told contributors to run the deprecated `validate` command, and listed gaps that have since shipped. - Correct the counts: 113 blocks, 25 components - `validate` -> `check` in the quick version - Document the `demo.html` requirement for components (CI fails without it) - Document `params` (drives the Studio customization panel) and the other optional registry-item fields - Add the monospace caption floor and `fitTextFontSize()` to the quality bar - Add a motion-review checklist: rules paired with a self-check question - Replace the manual preview-MP4 step with what catalog-previews CI does - Rewrite "What's Needed Right Now" by the job a shot does in a video, and drop the gaps that have shipped (karaoke, lower thirds, maps, news ticker)
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Merged
dahans-msft2
pushed a commit
to dahans-msft2/hyperframes
that referenced
this pull request
Aug 6, 2026
…m#2954) The guide still described a 52-block registry, told contributors to run the deprecated `validate` command, and listed gaps that have since shipped. - Correct the counts: 113 blocks, 25 components - `validate` -> `check` in the quick version - Document the `demo.html` requirement for components (CI fails without it) - Document `params` (drives the Studio customization panel) and the other optional registry-item fields - Add the monospace caption floor and `fitTextFontSize()` to the quality bar - Add a motion-review checklist: rules paired with a self-check question - Replace the manual preview-MP4 step with what catalog-previews CI does - Rewrite "What's Needed Right Now" by the job a shot does in a video, and drop the gaps that have shipped (karaoke, lower thirds, maps, news ticker)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rewrites
docs/contributing/catalog.mdx. The page had drifted from the repo on facts, commands, and gaps.Corrections (each verified against the repo, not the live site):
hyperframes lint+validatevalidateis a deprecated alias that prints a notice;checkis the gatedemo.htmlis requiredAdditions:
paramsdocumented, with the sample and the four types. Declaring them opens a live customization panel in Studio when the block is added. 6 of 113 blocks use it today, which is a direct consequence of no contributor-facing doc ever mentioning the field.registry-item.jsonfields in a short table (author,relatedSkill,registryDependencies,license,sourcePrompt,minCliVersion,deprecated).fitTextFontSize()requirement, both of which only existed in the skill reference.checkis not the same as the motion being good, and nothing in the guide covered that."What's Needed Right Now" is re-sorted by the job a shot does in a video rather than by technique. The registry has 29 transitions and 33 code blocks against 2 openings, 1 outro, and zero blocks for beat-driven cuts, interaction demos, or data readouts, which is the actual shape of the gap.
Why
The page is the entry point for external contributors. Every stale line in it costs a contributor a failed run:
validateprints a deprecation notice, a component withoutdemo.htmlfails catalog CI with no explanation on this page, and four of the nine listed gaps have already shipped, so a first-time contributor following the list builds a duplicate.How
Docs-only, single file. No schema change and no code change, so the when-to-use / pitfalls guidance is a PR-body convention rather than a new field.
Counts and behaviors were read from
registry/,packages/core/src/registry/types.ts,packages/cli/src/commands/validate.ts,scripts/generate-catalog-previews.ts, and.github/workflows/catalog-previews.yml.Not covered here, deliberately:
scripts/generate-catalog-pages.tsrendersauthorandrelatedSkillbut dropsparams, so a block's customization surface is invisible on its catalog page. Real gap, needs a code change, separate PR.paramsonto the 107 blocks that lack them.skills/hyperframes-registry/references/contributing.mdoverlaps this page and is more accurate in places. Leaving the consolidation for its own change.Test plan
Docs-only change. Verified every count and command claim against the repo at
411ada0d9; lefthook pre-commit (format, lint, tracked-artifacts, largefiles, commitlint) green.