-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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
[core] Replace relative links to absolute ones in JSDocs #43472
Conversation
Netlify deploy previewhttps://deploy-preview-43472--material-ui.netlify.app/ Bundle size report |
@alexfauquette a couple of questions:
|
Not really. It's like a standard. People writing links in JSDocs look at how other links are done. And so if they see all links starting with For the docs aspect, we could check the links looking for
When doing a major you would have two steps:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @alexfauquette!
I added this to our major release guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, a step forward
@@ -17,13 +17,13 @@ | |||
}, | |||
"default": "{}", | |||
"deprecated": true, | |||
"deprecationInfo": "use the <code>slots</code> prop instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | |||
"deprecationInfo": "use the <code>slots</code> prop instead. This prop will be removed in v7. See <a href=\"https://mui.com/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the future, I think that we want to automatically remove https://mui.com/
from those links to have relative URLs.
Follow up of #42472
Restart of #42528 to get a clearer commit history.
#42528 (comment)
After this PR links in all props should have an absolut link to the docs, allowing user to click on them from their IDE