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.

Sign up for GitHub

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

Jump to bottom

[docs] Add button and datagrid component guide, split Managing state doc #2678

Merged
merged 33 commits into from
Nov 20, 2023
Merged

[docs] Add button and datagrid component guide, split Managing state doc #2678

merged 33 commits into from
Nov 20, 2023

Conversation

prakhargupta1
Copy link
Member

@prakhargupta1 prakhargupta1 commented Sep 14, 2023 •
edited
Loading

  • Fix display-mode doc link from Toolpad

Changes:

  1. Button: https://deploy-preview-2678--mui-toolpad-docs.netlify.app/toolpad/components/button/
  2. DataGrid: https://deploy-preview-2678--mui-toolpad-docs.netlify.app/toolpad/components/datagrid/
  3. Managing state doc was changed to data binding
  4. A new doc Page properties was introduced

@prakhargupta1 prakhargupta1 added the docs Improvements or additions to the documentation label Sep 14, 2023
@prakhargupta1 prakhargupta1 marked this pull request as ready for review September 18, 2023 12:01
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 18, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 25, 2023
@Janpot Janpot added docs Improvements or additions to the documentation and removed docs Improvements or additions to the documentation labels Sep 26, 2023
@Janpot
Copy link
Member

Janpot commented Sep 26, 2023

@prakhargupta1 I updated this PR:

  • fixed building the docs with imports for @mui/toolpad-components in netlify
  • fixed display of the "sizes" demo (they were all showing the same size)
  • avoid using any of the @mui/toolpad-components for building demos. Just use the component that the page is about and use @mui/material (or standard html) to compose things together if needed.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 26, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 13, 2023
@prakhargupta1 prakhargupta1 changed the title [docs] Add button component guide [docs] Add button and datagrid component guide, split Managing state doc Oct 17, 2023
@prakhargupta1
Copy link
Member Author

3 issues in this PR:

  1. Screenshot 2023-10-17 at 4 12 32 PM

  2. Netlify deploy not working

  3. Datagrid license key to be added

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 17, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 31, 2023
@prakhargupta1 prakhargupta1 requested a review from a team November 2, 2023 11:30
@bharatkashyap
Copy link
Member

3 issues in this PR:

  1. Screenshot 2023-10-17 at 4 12 32 PM
  2. Netlify deploy not working
  3. Datagrid license key to be added

I've fixed these issues in the latest commits

@prakhargupta1
Copy link
Member Author

I added the changes we discussed, I don't know why the Netlify build is failing though.
Let me know if something is missing still.

@apedroferreira
Copy link
Member

I added the changes we discussed, I don't know why the Netlify build is failing though. Let me know if something is missing still.

Seems to be an issue with @mui/x-charts being an ESM module, I'll take a look to try to figure it out.

apedroferreira
apedroferreira reviewed Nov 10, 2023
View reviewed changes
docs/next.config.mjs
@@ -34,7 +34,7 @@ const MONOREPO_PACKAGES = {

export default withDocsInfra(
/** @type {import('next').NextConfig }} */ ({
transpilePackages: ['@mui/monorepo'],
transpilePackages: ['@mui/monorepo', '@mui/x-charts'],
Copy link
Member

@apedroferreira apedroferreira Nov 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@Janpot do you know if there is a better way to make this work, or is it fine to transpile @mui/x-charts when building the docs?

Copy link
Member

Choose a reason for hiding this comment

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

This is fine

apedroferreira
apedroferreira approved these changes Nov 10, 2023
View reviewed changes
Copy link
Member

@apedroferreira apedroferreira left a comment

Choose a reason for hiding this comment

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

Looks nice Prakhar!
I've added a possible fix for the build issue.

docs/data/toolpad/components/datagrid/datagrid.md Outdated Show resolved Hide resolved
@prakhargupta1 @apedroferreira
Update docs/data/toolpad/components/datagrid/datagrid.md
70e736b 
Co-authored-by: Pedro Ferreira <[email protected]>
Signed-off-by: Prakhar Gupta <[email protected]>
@prakhargupta1 prakhargupta1 enabled auto-merge (squash) November 12, 2023 16:49
@prakhargupta1 prakhargupta1 merged commit 4361dcf into mui:master Nov 20, 2023
11 checks passed
@prakhargupta1 prakhargupta1 deleted the button-component-guide branch November 23, 2023 10:18
@prakhargupta1 prakhargupta1 mentioned this pull request Nov 23, 2023
Closed
2 tasks
@oliviertassinari oliviertassinari mentioned this pull request Nov 26, 2023
Merged
@oliviertassinari
Copy link
Member

When changing pages, let's not forget to:

  1. Add redirections
  2. Update the links

Fixed in #2939

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Janpot Janpot Janpot left review comments

@apedroferreira apedroferreira apedroferreira approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@prakhargupta1 @Janpot @bharatkashyap @apedroferreira @oliviertassinari