Repository navigation
docs: clarify composition variable usage - #420
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
jrusso1020
left a comment
jrusso1020
left a comment
There was a problem hiding this comment.
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.
## 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/`
## 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/`
Summary
data-var-*example with the currentdata-variable-valuespatternVerification
npx mintlify dev --port 3100agent-browseron/concepts/compositionsand/reference/html-schematmp/issue-416-docs/