docs: add READMEs to examples/ directory#35
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ignsm
force-pushed
the
docs/example-readmes
branch
from
1cb2fc1 to
dd95b2f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an index
examples/README.mdplus a per-example README. Each one explains what the example demonstrates, how to run it (pnpm install --ignore-workspace && pnpm dev), and which files are worth copy-pasting into a new project.Closes the gap a fresh contributor hits today: clone the repo, find
examples/react-mui/, see a directory of source files with no entry point document and no clue how to start it. CI uses the same install-and-build commands the README now lists, so the instructions stay accurate.No code changes.