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

From the reference > component page, the component link doesn't take the user to the Material UI page. #3675

Open
prakhargupta1 opened this issue Jun 13, 2024 · 6 comments
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. scope: toolpad-studio Abbreviated to "studio"

Comments

@prakhargupta1
Copy link
Member

prakhargupta1 commented Jun 13, 2024

Steps to reproduce

Screen.Recording.2024-06-13.at.11.44.58.AM.mov

Current behavior

No response

Expected behavior

No response

Context

No response

Your environment

npx @mui/envinfo
  Don't forget to mention which browser you used.
  Output from `npx @mui/envinfo` goes here.

Search keywords: link

@prakhargupta1 prakhargupta1 added docs Improvements or additions to the documentation bug 🐛 Something doesn't work scope: toolpad-studio Abbreviated to "studio" labels Jun 13, 2024
@Janpot Janpot added the good first issue Great for first contributions. Enable to learn the contribution process. label Jun 13, 2024
@konekoya
Copy link
Contributor

Hi, I'd like to contribute. Is updating the Text Field documentation the only change needed?

@Janpot Janpot removed the good first issue Great for first contributions. Enable to learn the contribution process. label Jun 15, 2024
@Janpot
Copy link
Member

Janpot commented Jun 15, 2024

I noticed this link used to originally point to the core docs. We show this text both in the Toolpad docs, as well as in the Tooltip in the component editor. Let's discuss first what exactly UX we want exactly for both of these UIs before changing back the links

@prakhargupta1
Copy link
Member Author

We show this text both in the Toolpad docs, as well as in the Tooltip in the component editor.

My bad, I wasn't aware that it's a single source for both. From the editor (image below), I would expect the user to go to Toolpad docs. Then from the docs, a link taking her to the Material UI docs.

Screenshot 2024-06-17 at 10 48 00 PM

@Janpot
Copy link
Member

Janpot commented Jun 19, 2024

It says "the Material UI Button", to me it kind of makes sense to me to link to the Material UI docs. Perhaps we need to just disable that link in the Tooltip and add a second link at the bottom "Read more in the docs"?

@prakhargupta1
Copy link
Member Author

Yes, that sounds good. 👍

@Janpot
Copy link
Member

Janpot commented Jun 19, 2024

Ok, so let's do the following then:

  • Revert back the links in helperText to before the PR. i.e. linking to the Material UI docs.
  • Before feeding the helperText string to the MarkdownTooltip, remove all the links it contains.
  • Add a new optional docsUrl property in the component. Expand the tooltip with a line that says More info in the [docs](<docsUrl>).

@konekoya Feel free to take this, if you're still up for it.

@Janpot Janpot added the good first issue Great for first contributions. Enable to learn the contribution process. label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. scope: toolpad-studio Abbreviated to "studio"
Projects
None yet
Development

No branches or pull requests

3 participants