Skip to content

Convert manifest example from YAML to JSON and update doc metadata#339

Merged
eXamadeus merged 1 commit into
mainfrom
julian/06-15-convert_manifest_example_from_yaml_to_json_format_and_update_doc_metadata
Jun 15, 2026
Merged

Convert manifest example from YAML to JSON and update doc metadata#339
eXamadeus merged 1 commit into
mainfrom
julian/06-15-convert_manifest_example_from_yaml_to_json_format_and_update_doc_metadata

Conversation

@eXamadeus

Copy link
Copy Markdown
Member

Why

The manifest documentation example used YAML syntax, but facet.json is 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 sidebarTitle and tag to improve navigation and discoverability in the docs.

Copilot AI review requested due to automatic review settings June 15, 2026 05:04
@changeset-bot

changeset-bot Bot commented Jun 15, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4374bda

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mintlify

mintlify Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
AgentFacets 🟢 Ready View Preview Jun 15, 2026, 5:04 AM

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

Copy link
Copy Markdown
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@eXamadeus eXamadeus merged commit 79c8b0d into main Jun 15, 2026
5 of 6 checks passed
@eXamadeus eXamadeus deleted the julian/06-15-convert_manifest_example_from_yaml_to_json_format_and_update_doc_metadata branch June 15, 2026 05:05

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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"],

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

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.

2 participants