-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
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 #42528
base: next
Are you sure you want to change the base?
Conversation
Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: Anthony Gravell <[email protected]>
Co-authored-by: Alexandre Fauquette <[email protected]> Signed-off-by: Anthony Gravell <[email protected]>
Netlify deploy previewhttps://deploy-preview-42528--material-ui.netlify.app/ Bundle size report |
This introduce regressions to the docs API. These absolue URLs for the docs pages link will be broken as soon as the docs is moved to be verisoned, e.g. https://v4.mui.com. Not the end of the world, especially since we corrected handle these URLs loads as client side page navigation, not full page navigation, but it a simple search and replace can fix it, I think we should do it. https://deploy-preview-42528--material-ui.netlify.app/material-ui/api/accordion/. Now, in the future, we plan to move the docs to be at http://material-ui.mui.com. There, I'm not sure how we will handle the versioning of the docs. |
@oliviertassinari how do you suggest we go about this? For v5, I think we can add the |
@DiegoAndai I would use full URLs to the stable API for the .d.ts files. We use relative URLs for the link on the docs pages. It's not perfect, but it's still better than what we have today, so a step forward to improving the DX. |
Follow up of #42472