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

[docs] Fix API links for pickers #9573

Merged
merged 14 commits into from
Jul 6, 2023

Conversation

alexfauquette
Copy link
Member

No description provided.

@alexfauquette alexfauquette added docs Improvements or additions to the documentation component: pickers This is the name of the generic UI component, not the React module! labels Jul 5, 2023
@mui-bot
Copy link

mui-bot commented Jul 5, 2023

Netlify deploy preview

Netlify deploy preview: https://deploy-preview-9573--material-ui-x.netlify.app/

Updated pages

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 360.4 915.7 654.9 648.62 218.057
Sort 100k rows ms 918.9 1,478.4 1,411.4 1,269.94 196.591
Select 100k rows ms 323.7 612 386.7 416.56 100.877
Deselect 100k rows ms 261.6 494.2 334.4 339.62 84.648

Generated by 🚫 dangerJS against 9b75e89

@LukasTy
Copy link
Member

LukasTy commented Jul 5, 2023

❤️
I'd love to also align the name of the product with what is actually used in the head -> meta: mui/material-ui#37825

@LukasTy
Copy link
Member

LukasTy commented Jul 5, 2023

Validation page is missing the productId header.

The code examples seem to be parsed incorrectly 🤷

@LukasTy
Copy link
Member

LukasTy commented Jul 5, 2023

Seeing all the necessary changes raises a question:
Wouldn't reverting to highlight v4 be an easier option?
At least until the monorepo bumps it to v5? 🤔

@alexfauquette
Copy link
Member Author

Wouldn't reverting to highlight v4 be an easier option?

This need come from @mui/monorepo so I don't see how to avoid it

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 5, 2023

Thanks for fixing the regression I introduced.

Things that could be great to do in the future:

  1. Move the markdown location in the file system to match the URL, the mismatch creates a complex routing logic today.
  2. (maybe) normalize the API paths from https://mui.com/x/api/data-grid/ to https://mui.com/x/react-data-grid/api/, simpler but longer URL
  3. In the markdown loader, import getProductInfoFromUrl() to set the productId based on the pathname prefix, so we don't need to repeat productId in the markdown, and more importantly, so any URLs that break the convention can be easily spotted.
  4. Remove the getProductInfoFromUrl() in _app.js so that the productId coming from the markdown can take precedence. Right now, we have to set the productId twice for each page almost in isolation. This is because

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work regression A bug, but worse labels Jul 5, 2023
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!
Really nice changes on code snippets! ❤️

docs/data/data-grid/getting-started/getting-started.md Outdated Show resolved Hide resolved
@LukasTy LukasTy mentioned this pull request Jul 5, 2023
1 task
@LukasTy LukasTy removed the bug 🐛 Something doesn't work label Jul 6, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 6, 2023
@github-actions
Copy link

github-actions bot commented Jul 6, 2023

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 6, 2023
@alexfauquette alexfauquette merged commit 9b448a8 into mui:master Jul 6, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: pickers This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation regression A bug, but worse
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants