Skip to content

[internal] Improve the playground DX#34739

Merged
oliviertassinari merged 3 commits into
mui:masterfrom
oliviertassinari:improve-playground
Oct 14, 2022
Merged

[internal] Improve the playground DX#34739
oliviertassinari merged 3 commits into
mui:masterfrom
oliviertassinari:improve-playground

Conversation

@oliviertassinari

@oliviertassinari oliviertassinari commented Oct 12, 2022

Copy link
Copy Markdown
Member

As promised #29423 (comment) 😁. The changes in this PR bring the following improvements:

  1. We can have more than ONE playground, I think that it's the pain point raised by Jun in https://mui-org.slack.com/archives/C0170JAM7ML/p1665545318417579
  2. We no longer build the example playground: https://mui.com/playground.example
  3. We make it easier to get started, best for the community to use it.

@oliviertassinari oliviertassinari added the internal Behind-the-scenes enhancement. Formerly called “core”. label Oct 12, 2022
@mui-bot

mui-bot commented Oct 12, 2022

Copy link
Copy Markdown

No bundle size changes

Generated by 🚫 dangerJS against 81d62dd

@LukasTy LukasTy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It looks good and seems to solve the same cases we covered in mui-x repository.

Just a few suggestion for text improvements:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b0ebab1f24..3223108842 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -94,20 +94,22 @@ Changes to the docs will hot reload the site.
 
 ### Trying changes on the playground
 
-While we recommand to try your changes on the documentation site, it's not always ideal.
-You can face problems this way:
+While we recommend to try your changes on the documentation site—it's not always ideal.
+You might face following problems:
 
 - updating the existing demos prevent you to work in isolation on a single instance of the component
 - emptying an existing page to try your changes in isolation lead to a noisy `git diff`
 - static linters will report issues that you might not care about.
 
-To solve these problems, you can use the playground:
+To solve these problems—you can use the playground:
 
 
-You can now access it locally http://localhost:3000/playground/.
+You can now access it locally: http://localhost:3000/playground/.
+
+You can create as many playgrounds as you want—they will be accessible under: `http://localhost:3000/playground/<file_name>`.
 
 ### How to increase the chance of being accepted?
 

@oliviertassinari
oliviertassinari enabled auto-merge (squash) October 14, 2022 21:34
@oliviertassinari
oliviertassinari merged commit 30b2514 into mui:master Oct 14, 2022
@oliviertassinari
oliviertassinari deleted the improve-playground branch October 14, 2022 21:49
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
@oliviertassinari oliviertassinari changed the title [core] Improve the playground DX [internal] Improve the playground DX Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Behind-the-scenes enhancement. Formerly called “core”.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants