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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs][joy-ui] Enforce standard structure, style, and grammar across all docs #33998
Open
29 of 61 tasks
Labels
docs
Improvements or additions to the documentation
on hold
There is a blocker, we need to wait
package: joy-ui
Specific to @mui/joy
Milestone
Comments
samuelsycamore
added
docs
Improvements or additions to the documentation
package: joy-ui
Specific to @mui/joy
labels
Aug 19, 2022
1 task
Thanks! @samuelsycamore. |
Thanks @samuelsycamore, I appreciate the thorough response to my request! Feel free to let me know where you'd like a second review,. |
This was referenced Aug 26, 2022
This was referenced Oct 2, 2022
This was referenced Oct 20, 2022
This is the page structure/template that I plan to use going forward:
|
This was referenced Jan 5, 2023
1 task
This was referenced Apr 5, 2023
1 task
samuelsycamore
changed the title
[docs] Revise Joy UI documentation for grammar and style consistency
[docs] Enforce standard structure, style, and grammar across all Joy UI docs
Aug 3, 2023
samuelsycamore
changed the title
[docs] Enforce standard structure, style, and grammar across all Joy UI docs
[docs][joy-ui] Enforce standard structure, style, and grammar across all docs
Sep 6, 2023
This was referenced Oct 7, 2023
I'm placing this issue on hold for now as the Core team shifts focus to Material UI for the first half of 2024. |
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
on hold
There is a blocker, we need to wait
package: joy-ui
Specific to @mui/joy
The problem
The Joy UI documentation currently contains inconsistent grammar, style, voice, and formatting throughout. It's important to address this non-technical debt (prose debt? 馃槄) as we continue to grow this library and prepare for the stable release.
I would like to audit and revise each existing page individually to apply our company style guide and best practices for writing documentation.
Scope
The primary goal is consistency. I'm less concerned with adding new content except where we find major gaps that need to be covered.
I intend to review each page individually. Most pages will get their own PR, but some may be grouped together if the edits are minimal. I'll edit as needed for grammar, style, page formatting, content clarity, and completeness.
I don't intend to do any restructuring of the doc nav menu here.
This is a big project, so I expect it to be ongoing for a while. This issue is where we can keep track of the progress.
Pages
The text was updated successfully, but these errors were encountered: