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 a text field for a discouragement reason #2700

Open
ddbeck opened this issue Feb 25, 2025 · 1 comment
Open

Add a text field for a discouragement reason #2700

ddbeck opened this issue Feb 25, 2025 · 1 comment
Labels
enhancement New feature or request schema Schema changes, proposals, and bugs

Comments

@ddbeck
Copy link
Collaborator

ddbeck commented Feb 25, 2025

Talking to the MDN folks, they'd like a brief summary of why a given feature was marked discouraged.

They'd like this so that they can generate, from web-features, deprecation banners that correspond the most common cases on MDN, where there's mostly boilerplate text with a sentence explaining the reason for the deprecation.

This seems in-scope for what we're doing, like descriptions.

For example, for mutation-events:

Mutation events have poor performance and browser vendors plan to remove support for them in 2025.

Or for import-assertions we might have something like:

Import assertions are superseded by import attributes.

@ddbeck ddbeck added enhancement New feature or request schema Schema changes, proposals, and bugs labels Feb 25, 2025
@captainbrosset
Copy link
Contributor

captainbrosset commented Feb 26, 2025

I agree we should do this. We've kind of tried to stay away from adding too much information and content to web-features, because things on the web platform move a lot. But the kind of features we're talking about doing this for don't move anymore at all. So it feels pretty good for the project to act as a little summary of whatever is written at according_to, so that consumers can display:

This feature is discouraged: ${feature.discouraged.reason} (<a href="${feature.discouraged.according_to}">learn more</a>)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request schema Schema changes, proposals, and bugs
Projects
None yet
Development

No branches or pull requests

2 participants