-
-
Notifications
You must be signed in to change notification settings - Fork 44
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
Update document #81
Update document #81
Conversation
- Update post install message - Update readme to explain the different between init modes.
Reviewer's Guide by SourceryThis PR updates documentation and post-installation messages to better explain the different initialization modes of SaladUI and marks some components as completed. The changes primarily focus on clarifying the distinction between using SaladUI as a library versus as part of a project, and includes usage examples. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @bluzky - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@@ -29,6 +29,9 @@ | |||
|
|||
1. **Using `salad_ui` as part of your project:** | |||
|
|||
> This way you can install only components that you want to use or you want to edit SaladUI's component source code to fit your need. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): Grammar: 'need' should be 'needs'
@@ -67,6 +70,20 @@ | |||
#> mix salad.init --as-lib | |||
``` | |||
|
|||
- Using in your project | |||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (documentation): Add language specification to code block
Please specify the language as elixir
for proper syntax highlighting
Summary by Sourcery
Clarify initialization modes in the README and update the post-install message to reflect the selected mode.
Enhancements:
Documentation: