fix(docs): serve hyperframes.json / registry JSON schemas (#304)#305
Merged
miguel-heygen merged 1 commit intomainfrom Apr 17, 2026
Merged
fix(docs): serve hyperframes.json / registry JSON schemas (#304)#305miguel-heygen merged 1 commit intomainfrom
miguel-heygen merged 1 commit intomainfrom
Conversation
The three /schema/*.json URLs baked into every Hyperframes project as \$schema references were all 404ing on the live docs site — blocking editor autocomplete and validation for hyperframes.json, registry.json, and registry-item.json. Adds docs/schema/ so Mintlify serves the three expected URLs: - /schema/hyperframes.json (new — authored from ProjectConfig) - /schema/registry.json (mirrored from packages/core/schemas/) - /schema/registry-item.json (mirrored from packages/core/schemas/) The registry schemas stay authoritative in packages/core/schemas/ where they're npm-exported for @hyperframes/core consumers. scripts/sync-schemas.ts mirrors them into docs/schema/ and a new --check mode fails the Docs workflow if the two drift, so the npm copy and the docs copy can't diverge silently. Validated against the factory-series-c-video config + a default config generated by hyperframes init; negative cases (missing registry, extra top-level keys, empty required strings) reject as expected.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
vanceingalls
approved these changes
Apr 17, 2026
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
2 participants
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.
Closes #304.
Summary
The three
/schema/*.jsonURLs baked into every Hyperframes project as\$schemareferences are 404ing on the live docs site — blocking editor autocomplete and validation.Mintlify serves top-level non-MDX dirs in `docs/` at `/<dir>/` (confirmed by `docs/logo/.svg` → `/logo/*.svg`). This PR drops the three schemas into `docs/schema/` so the URLs resolve.
What changed
Why not make `packages/core/schemas/` authoritative for `hyperframes.json` too?
`hyperframes.json` is CLI config, not a core type. Keeping the schema in `docs/` avoids an artificial dependency between `@hyperframes/core` and `@hyperframes/cli`. If the two ever need to align, we can flip the direction then.
Verification
Test plan
Notes