Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badge to documentation to indicate when a certain feature has been made available #305

Open
pennal opened this issue Oct 11, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pennal
Copy link
Collaborator

pennal commented Oct 11, 2024

What problem does this feature solve?

Currently there is no indication when a certain feature/prop/method has made available, This can lead to issues since users may be using an older version of the library that does not provide this option.

What does the proposed API look like?

The idea would be to use the badge component from the default theme, this way we could indicate the version that introduced the feature.

There are multiple locations where this can be used:

  • Title of the component / intro explanation.
  • Properties and events (table)

To achieve this result, the proposed solution is to tap into the document generation step from stencil. This way, we could use an annotation that takes care of handling the correct placement of this component. This would then result in having the version in all required places. JSDoc (used by stencil) also provides the ability to use the @since tag (docs), this may be an even easier way to add the badge.

Release process may need clarification, since the developer may not know when this feature will be introduced, or better said what version number it will have

@colinscz colinscz added the enhancement New feature or request label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants