Skip to content

docs: version tags for examples#22652

Draft
J-Sek wants to merge 2 commits intomasterfrom
feat/docs-example-badge
Draft

docs: version tags for examples#22652
J-Sek wants to merge 2 commits intomasterfrom
feat/docs-example-badge

Conversation

@J-Sek
Copy link
Copy Markdown
Contributor

@J-Sek J-Sek commented Feb 25, 2026

resolves #22645

  • discuss: what minimal version do we want to show? v3.6.0 or v4.0.0
image

@J-Sek J-Sek self-assigned this Feb 25, 2026
@J-Sek J-Sek requested a review from a team February 25, 2026 08:53
@J-Sek J-Sek force-pushed the feat/docs-example-badge branch from 4a10cac to 4f7e28d Compare February 25, 2026 09:31
@MajesticPotatoe
Copy link
Copy Markdown
Member

MajesticPotatoe commented Feb 25, 2026

It make more sense to use a json file to track all this, and then incorporate the tag into the example.vue component. (we already do this on a component basis via new-in.json, so could just add it into their)

@J-Sek
Copy link
Copy Markdown
Contributor Author

J-Sek commented Feb 25, 2026

Would it meant we rely on the example file names to include the exact name after initial prefix? The prop is dumb/simple and could end up with lower mental overhead in comparison to some magic resolver. API docs are more strict and it makes sense there. Curious what others would think.

@MajesticPotatoe
Copy link
Copy Markdown
Member

MajesticPotatoe commented Feb 25, 2026

Name is already available in example component (because it uses it to get the actual example file) so a lookup into the json should also be simple.

Was more for consistency with what already is done, and to increase flexibility/usability (eg if you want to use that information elsewhere, such as a page that lists all of the new components by version).

could be as simple as

{
  "Examples": {
    "v-avatar/prop-size": "3.4.0",
    // or
    "v-avatar": {
      "prop-size": "3.4.0"
    }
  }
}

or add on the the existing structure

{
  "VAvatar": {
    "props": {
      "text": "3.4.0",
    },
    "examples": {
      "prop-size": "3.4.0"
    }
  }
}

@J-Sek J-Sek marked this pull request as draft March 11, 2026 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Missing "minimum version" tags for examples in v4 docs

2 participants