docs(examples): improve README with comprehensive documentation#627
Open
vincent067 wants to merge 1 commit intoovh:masterfrom
Open
docs(examples): improve README with comprehensive documentation#627vincent067 wants to merge 1 commit intoovh:masterfrom
vincent067 wants to merge 1 commit intoovh:masterfrom
Conversation
- Add detailed table of contents - Document hello-world-now template with feature breakdown - Include running instructions and expected outputs - Add best practices section - Include common patterns examples - Add guidance on creating custom templates Closes ovh#298
vincent067
requested review from
loopfz,
rbeuque74,
rclsilver and
wI2L
as code owners
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.
This PR improves the examples README.md with comprehensive documentation to help new users understand the templates.
Changes
Why
As a new user exploring µTask, I found the examples helpful but the README was quite minimal. Having more detailed explanations would have helped me understand the concepts faster. This change makes the examples more educational and self-contained.
Closes #298
Happy to adjust anything if needed! 😊