docs(compositions): remove Variables section referencing unshipped syntax#421
Closed
jrusso1020 wants to merge 1 commit intomainfrom
Closed
docs(compositions): remove Variables section referencing unshipped syntax#421jrusso1020 wants to merge 1 commit intomainfrom
jrusso1020 wants to merge 1 commit intomainfrom
Conversation
…ntax The documented `data-var-*` attribute pattern is not implemented — the parser reads `data-composition-variables` (schema JSON on <html>) and `data-variable-values` (instance JSON on the composition element), not per-attribute `data-var-<name>`. There is no Studio UI, example composition, or author-facing consumer API for variables today, so the section left readers with no way to actually use what it described. Cut the section for now. The underlying parser/generator support stays in place and can be re-documented once there is a real author-facing surface (Studio UI + example + consumer pattern). Closes #416
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Collaborator
Author
|
Superseded by #420 — Miguel's PR takes the better approach: keeps the Variables section but rewrites it with the real |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Removes the Variables section from
docs/concepts/compositions.mdx(lines 128–136 on main).Why
Reported in #416. The docs example shows a syntax that doesn't exist:
Grep confirms
data-var-appears only in that one docs snippet (and its bundled copy atpackages/cli/dist/docs/compositions.md). The parser and generator don't read per-attributedata-var-<name>at all — they readdata-composition-variables(schema JSON on<html>) anddata-variable-values(instance JSON on the composition element).Beyond the wrong attribute name, the variable system isn't really author-facing yet:
URLSearchParams(location.search)inside their composition script (the generator encodes values as iframe query-string params), and nothing in the docs says soSo the section was actively misleading — it advertised a reusability feature with a syntax that isn't wired up and a consumer story that isn't documented.
How
Deleted the
## Variablesheading and its three content lines. No other docs referenced the removed section (grepped for#variablesanchors; none exist), so no dangling links.The underlying parser/generator support (
extractCompositionMetadata,data-variable-valuesserialization) stays in place and can be re-documented once there is a real author-facing surface — Studio UI + consumer helper + example composition.Test plan
docs/for broken anchor refs to the removed section; none foundCloses #416