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-update #1829

Merged
merged 6 commits into from
Apr 10, 2023
Merged

Docs-update #1829

merged 6 commits into from
Apr 10, 2023

Conversation

prakhargupta1
Copy link
Member

@prakhargupta1 prakhargupta1 commented Mar 29, 2023

Data binding and deployment updates. Things to fix:

  1. Deployment icon (done)
  2. Verify deployment content (done)

Screenshot 2023-03-29 at 1 27 31 PM

Screenshot 2023-03-29 at 1 27 14 PM

Data binding and deployment updates. Things to fix:
1. Deployment icon
2. Verify deployment content
@prakhargupta1
Copy link
Member Author

It would be great, if we can add a thin border on all of our images. Something like core docs also has:

Screenshot 2023-03-29 at 1 38 44 PM

Or if there something better that someone might want to suggest.

@prakhargupta1 prakhargupta1 added the docs Improvements or additions to the documentation label Mar 29, 2023
Copy link
Member

Choose a reason for hiding this comment

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

This image seems a bit small.
Maybe we can have clearer "before" and "after" images so we can see how the binding changed things?

Copy link
Member Author

Choose a reason for hiding this comment

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

In the pic above this one, I have tried to show the binding and in the background there is the before image. Hopefully, it should be ok.

@apedroferreira
Copy link
Member

Deployment icon: maybe a rocket? :)

@apedroferreira
Copy link
Member

It would be great, if we can add a thin border on all of our images. Something like core docs also has:

Screenshot 2023-03-29 at 1 38 44 PM

Or if there something better that someone might want to suggest.

I think whatever Core does on their images we could do the same, since the docs look similar.
Let me know if I should look into it!

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.

Nice one, Prakhar, just left some feedback and suggestions for copy changes!
All my opinion of course so feel free to disagree with any of them.

@apedroferreira
Copy link
Member

apedroferreira commented Mar 29, 2023

I've added a commit documenting toolpad-display=standalone since we will add it soon and there is a Deployment section in this PR where it feels appropriate.
I didn't include any images as maybe we should have a nice looking app to take screenshots from, and it didn't feel completely necessary in this case.

@prakhargupta1
Copy link
Member Author

Deployment icon: maybe a rocket? :)

That should be good! @apedroferreira Need your help in this. As per pages.ts it has something to do with mono repo docs.

@apedroferreira
Copy link
Member

Deployment icon: maybe a rocket? :)

That should be good! @apedroferreira Need your help in this. As per pages.ts it has something to do with mono repo docs.

Just changing the icon? I'll try it.

@prakhargupta1
Copy link
Member Author

Just changing the icon? I'll try it.

Yes

@apedroferreira
Copy link
Member

apedroferreira commented Apr 6, 2023

Just changing the icon? I'll try it.

Yes

My bad, looks like it's only possible to use icons from this file in those docs nav items https://github.com/mui/material-ui/blob/master/docs/src/modules/components/AppNavDrawerItem.js (iconsMap starting in line 24)
So we can stick to the current one for now, but I can make a PR there to add the rocket icon, I guess I'll make a PR.

PR: mui/material-ui#36789

Picked a different icon for it to be merged.
@prakhargupta1 prakhargupta1 merged commit 61ddb78 into master Apr 10, 2023
@prakhargupta1 prakhargupta1 deleted the docs-update branch April 10, 2023 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants