Skip to content

docs: clarify composition variable usage#420

Merged
miguel-heygen merged 1 commit intomainfrom
fix/docs-composition-variables
Apr 22, 2026
Merged

docs: clarify composition variable usage#420
miguel-heygen merged 1 commit intomainfrom
fix/docs-composition-variables

Conversation

@miguel-heygen
Copy link
Copy Markdown
Collaborator

Summary

  • replace the unsupported data-var-* example with the current data-variable-values pattern
  • document that variable values are carried through but still applied manually inside the nested composition
  • add matching reference notes in the data-attributes, HTML schema, core package, and CLI docs

Verification

  • npx mintlify dev --port 3100
  • browser verification with agent-browser on /concepts/compositions and /reference/html-schema
  • proof artifacts saved locally under tmp/issue-416-docs/

@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 22, 2026

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

Project Status Preview Updated (UTC)
hyperframes 🟢 Ready View Preview Apr 22, 2026, 6:32 PM

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

Copy link
Copy Markdown
Collaborator

@jrusso1020 jrusso1020 left a comment

Choose a reason for hiding this comment

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

Nice — this is the right direction. Documents the real data-variable-values pattern, keeps the section useful for readers who hit #416, and the cross-reference updates across data-attributes / html-schema / core / CLI docs keep everything consistent. Approving.

One nit (non-blocking, fine as a follow-up):

The compositions/card.html code block wraps the composition in <template id="card-template">. Other docs show composition files as top-level roots — <html data-composition-id="..."> (e.g. docs/reference/html-schema.mdx:38) or <div id="root" data-composition-id="..."> (e.g. docs/quickstart.mdx:167, docs/introduction.mdx:13). A <template> element doesn't render without being cloned/instantiated, so as a copy-paste example of an authored composition file the wrapper is a bit misleading — readers might copy it verbatim and wonder why nothing shows up. Would drop the <template> wrapper and show a bare composition root, matching the rest of the docs.

@miguel-heygen miguel-heygen merged commit fc52d21 into main Apr 22, 2026
21 checks passed
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