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

[core] Replace relative links to absolute ones in JSDocs #42528

Open
wants to merge 8 commits into
base: next
Choose a base branch
from

Conversation

alexfauquette
Copy link
Member

Follow up of #42472

@mui-bot
Copy link

mui-bot commented Jun 4, 2024

Netlify deploy preview

https://deploy-preview-42528--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against e681e11

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 7, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 7, 2024
@alexfauquette alexfauquette marked this pull request as ready for review June 7, 2024 09:03
@zannager zannager added the core Infrastructure work going on behind the scenes label Jun 7, 2024
@zannager zannager requested a review from DiegoAndai June 7, 2024 12:46
@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 7, 2024

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.

@DiegoAndai
Copy link
Member

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/.

@oliviertassinari how do you suggest we go about this?

For v5, I think we can add the https://v5.mui.com/... when we release v6. Don't know if we can/should do the same for v4 or previous versions.

@oliviertassinari
Copy link
Member

how do you suggest we go about this?

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants