Skip to content

Commit 311ac6e

Browse files
committed
docs: correct two contributor instructions that the source contradicts
Both P1s from Miguel's review on #2976. **The weekly changelog command has a fourth output, and it is public.** `changelog-process.mdx` listed three internal drafts. `outputWeeklyDraft` also calls `prependDocsUpdate` on `--write` (`scripts/changelog-weekly.ts:236`), which writes straight into `docs/weekly-updates.mdx`. A contributor following the page would review three files and push a fourth unread. Now called out as a warning, with the re-run behaviour, since that is what makes editing the entry afterwards safe. The same paragraph also said Weekly updates is "unlisted in the sidebar". That was true when written and I made it false myself, putting the page back under Explore in #2978 after Rames found it orphaned. Corrected rather than reverted — the page belongs in the sidebar. **Bare `hyperframes lint` cannot validate a registry item.** Both `contributing.mdx` and `contributing/catalog.mdx` told contributors to run it. The CLI resolves a project by looking for `index.html` (`packages/cli/src/utils/project.ts`), and registry items ship as `<name>.html` or `demo.html`, so it fails with "No composition found". This is not theoretical: `scripts/lint-registry-items.mjs` exists precisely for this shape and its header records two `gsap_non_transform_motion` errors that reached main unlinted because of it. Both pages now document `bun run lint:registry-items`, and the Catalog page shows the install-into-a-scratch-project route for the full `check` gate rather than claiming a bare `check` covers a registry item. Verified by running the documented command, not just by reading the script.
1 parent eabf2fa commit 311ac6e

3 files changed

Lines changed: 36 additions & 7 deletions

File tree

docs/contributing.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,23 @@ bun run --filter '*' typecheck
3333
bun run test
3434
```
3535

36-
For a composition or registry item, also run:
36+
For a composition, run the gates from the project directory, or pass it:
3737

3838
```bash
39-
npx hyperframes lint
40-
npx hyperframes check
39+
npx hyperframes lint ./my-video
40+
npx hyperframes check ./my-video
41+
```
42+
43+
Registry items need a different command. They ship as `<name>.html` or
44+
`demo.html`, and the CLI resolves a project by looking for `index.html`, so
45+
pointing it at an item directory fails with "No composition found" — which is
46+
how two `gsap_non_transform_motion` errors once reached `main` unlinted. Use the
47+
script that mounts each item into a throwaway project first, exactly where
48+
`hyperframes add` would put it:
49+
50+
```bash
51+
bun run lint:registry-items # every item
52+
bun run lint:registry-items my-block # just one
4153
```
4254

4355
The pre-commit hooks format staged files and run checks for the files you changed.

docs/contributing/catalog.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,19 @@ A one-off example belongs in [Examples](/examples), not the Catalog.
101101

102102
## Validate and preview
103103

104-
Run the composition gates:
104+
Lint the item the way a user receives it — mounted into a real project. A bare
105+
`npx hyperframes lint` cannot validate a registry directory, because the CLI
106+
looks for `index.html` and items ship as `<name>.html` or `demo.html`:
105107

106108
```bash
107-
npx hyperframes lint
109+
bun run lint:registry-items my-block
110+
```
111+
112+
To exercise the full gate, install the item into a scratch project and run there:
113+
114+
```bash
115+
npx hyperframes init scratch && cd scratch
116+
npx hyperframes add my-block
108117
npx hyperframes check
109118
```
110119

docs/contributing/changelog-process.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,21 @@ bun run changelog:weekly --from 2026-06-01 --to 2026-06-07 --write
9393

9494
Run it from an up-to-date `main` branch so the selected range reflects public history, not a feature branch.
9595

96-
This creates internal editorial drafts:
96+
This writes three internal editorial drafts:
9797

9898
- `updates/weekly/2026-06-07.md`
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. 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).
102+
<Warning>
103+
It also writes a fourth file, and that one is public. `--write` prepends the
104+
generated entry straight into `docs/weekly-updates.mdx`, which ships in the
105+
sidebar under **Explore**. Review that diff with the same care as the page it
106+
is — it is not a draft. Re-running for a range already present is a no-op, so
107+
the entry is safe to edit in place afterwards.
108+
</Warning>
109+
110+
Review and rewrite all four before publishing anything. Social drafts are never posted automatically. Exact versioned release notes stay in the [Changelog](/changelog); [Weekly updates](/weekly-updates) carries the curated highlights and an RSS feed.
103111

104112
## Writing style
105113

0 commit comments

Comments
 (0)