[docs-infra] Display deprecation messages in API pages #42352
Merged
Conversation
This file contains 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
aarongarciah
changed the title
Netlify deploy previewhttps://deploy-preview-42352--material-ui.netlify.app/ Bundle size report |
aarongarciah
force-pushed
the
aarongarciah/docs-api-deprecation-messages
branch
4 times, most recently
from
2aff948
to
e4253ba
Compare
|
@michaldudak is it worth applying the changes to Base UI docs? I'm not sure what the status of Base UI docs is so I don't want to spend time there if it's going to go away soon. |
|
The current Base UI docs will be replaced sometime in the future, so I don't think it's worth spending time on them now. The new Base UI docs can make use of it, but it's not urgent. We're not stable yet, so we don't think about deprecated APIs now :) |
alexfauquette
approved these changes
May 24, 2024
aarongarciah
force-pushed
the
aarongarciah/docs-api-deprecation-messages
branch
from
e4253ba
to
0a9a789
Compare
|
Updated the PR leveraging Danilo's Alerts standardization and switched the target branch to be next. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Now that we're able to use JSDoc tags to annotate components and hooks (see #42327), we can use
@deprecatedJSDoc tags from components and hooks as the source of truth to automatically display deprecation alerts in API pages.Changes included in this PR:
deprecatedproperty in docs json files (e.g. docs/pages/material-ui/api/hidden.json)deprecationInfoproperty in docs translation json files (e.g. docs/translations/api-docs/hidden/hidden.json)deprecationInfofield is empty, display a generic message.ℹ️ Important: the changes work in API pages from Material, Joy, and System. The deprecation alert is not displayed in Base UI pages for now. I've pinged the Base UI to see if it's also worth applying the changes there.
Preview link: https://deploy-preview-42352--material-ui.netlify.app/material-ui/api/hidden/