[docs] Some API descriptions require horizontal scroll to be read in full
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Duplicates
- I have searched the existing issues
Latest version
- I have tested the latest version
Current behavior 😯
Some API docs require horizontal scroll to see the full (or any in some cases) API descriptions, including Checkbox and Pickers.
See, for example:
When we look at the docs page, it's not rendering the same note. However, when we go to "edit this page", it just points right back to the code docs. https://mui.com/api/checkbox/
Expected behavior 🤔
https://mui.com/api/checkbox/ should be updated to be more clear that this value gets converted to a string. Bonus points for explaining why this is so important, and how you might need to work around it.
Steps to reproduce 🕹
N/A
Context 🔦
No response
Your environment 🌎
N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Checkbox.d.ts lines and compare their API description with the rendered page at mui.com/api/checkbox/. Trace the “edit this page” destination to understand where this text is sourced; done means the relevant value conversion is clearly explained on the API page without requiring horizontal scrolling.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100