Skip to content

docs(registry): explain installer metadata - #3658

Merged
jrusso1020 merged 1 commit into
mainfrom
refresh/registry-metadata-1410
Sep 4, 2026
Merged

docs(registry): explain installer metadata#3658
jrusso1020 merged 1 commit into
mainfrom
refresh/registry-metadata-1410

Conversation

@jrusso1020

Copy link
Copy Markdown
Collaborator

The catalog lists installer metadata fields but does not explain their behavior. Document transitive dependencies, minimum CLI versions, and deprecation warnings in the current catalog and CLI guides.

Refreshes #1410 by @kiyeonjeon21, preserving the original author. The current installer gates all resolved items before writing item files; it may create hyperframes.json earlier, so the wording makes that distinction.

Validation: traced current add/resolver/compatibility code; 25 existing registry tests pass; catalog JSON examples, Markdown fences, and git diff checks pass. The repository formatter does not support MDX. No runtime changes.

@mintlify

mintlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hyperframes 🟢 Ready View Preview Sep 4, 2026, 10:01 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 81c133ca2a5680c2421b15ea95fee3536ccfc854; no actionable findings.

docs/contributing/catalog.mdx:94 correctly limits the compatibility guarantee to item files: runAdd can write the project config first, then gates every resolved dependency before installation. The dependency ordering, missing/cyclic dependency rejection, and non-blocking deprecation wording match the current resolver and compatibility implementation.

Checked both complete diffs and the underlying add/resolver/compatibility paths. JSON examples parse, Markdown fences balance, and GitHub docs validation, formatting, CodeQL, and Mintlify deployment passed; runtime jobs were skipped for this docs-only change. No prior substantive reviews to duplicate. No dependencies installed or local runtime tests run.

Verdict: APPROVE
Reasoning: The documentation accurately describes the current installer and keeps the change limited to the missing guidance.

— Magi

@jrusso1020
jrusso1020 merged commit 29efd5d into main Sep 4, 2026
47 checks passed
@jrusso1020
jrusso1020 deleted the refresh/registry-metadata-1410 branch September 4, 2026 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants