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] Revise Example Projects and Related Projects pages #44191

Merged
merged 9 commits into from
Nov 1, 2024

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Oct 22, 2024

part of #40062

To clarify the purpose of each of these pages so there's no confusion or overlap - move "Community Projects" from Example Projects to Related Projects and reorganize the lists accordingly.

Also removed several outdated community projects - those which have not been updated to v5+.

Preview:

Example projects

  • list official (i.e. maintained by MUI) third-party integrations - minimal scaffolds and boilerplates
  • link to (official) free and paid templates
  • community developers should not be encouraged to open PRs to link their projects here

Related projects

  • list community-led projects and tools that incorporate or extend Material UI
  • community developers can open PRs to link to their projects here

Showcase (beyond the scope of this PR)

  • live projects, products, and apps that use Material UI

@samuelsycamore samuelsycamore added the docs Improvements or additions to the documentation label Oct 22, 2024
@mui-bot
Copy link

mui-bot commented Oct 22, 2024

@samuelsycamore samuelsycamore marked this pull request as ready for review October 24, 2024 17:28
@samuelsycamore
Copy link
Contributor Author

samuelsycamore commented Oct 24, 2024

Maybe the h4s are unnecessary on the Related projects page? They're kind of redundant since there's only one item listed under each. We could remove them and just list all of the supplementary components under the h3.

Copy link
Member

@aarongarciah aarongarciah left a comment

Choose a reason for hiding this comment

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

@samuelsycamore samuelsycamore merged commit 8635e3c into mui:master Nov 1, 2024
22 checks passed
Comment on lines -52 to +67
### Rich text

- [mui-tiptap](https://github.com/sjdemartini/mui-tiptap): A customizable Material UI-styled WYSIWYG (What You See Is What You Get) rich text editor, using [Tiptap](https://tiptap.dev/).

### Sparkline
#### Rich text editor
Copy link
Member

@oliviertassinari oliviertassinari Nov 3, 2024

Choose a reason for hiding this comment

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

Rich text -> Rich text editor

I was about to make this same change 👍. I got confused reading Rich text on this page today.

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.

4 participants