Convert manifest example from YAML to JSON and update doc metadata#339
Conversation
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4374bdab99
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "version": "1.0.0", | ||
| "description": "Acme org developer toolkit", | ||
| "author": "acme-org", | ||
| "skills": ["code-standards", "pr-template"], |
There was a problem hiding this comment.
Make the JSON example schema-valid
Because this block is now presented as a copyable facet.json, the skills array will fail manifest validation: the canonical schema defines skills as a record of skill names to descriptors (type.Record('string', SkillDescriptor) in packages/protocol/src/schemas/facet-manifest.ts), and each descriptor requires a description. Users following this example will get rejected before build/install, so the example should use an object such as skill names mapped to descriptor objects.
Useful? React with 👍 / 👎.

Why
The manifest documentation example used YAML syntax, but
facet.jsonis a JSON file. This mismatch was misleading for anyone referencing the example to write their own manifest.Details
The example block has been converted from YAML to valid JSON, and the page frontmatter has been updated with a
sidebarTitleandtagto improve navigation and discoverability in the docs.