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

Update document #81

Merged
merged 3 commits into from
Nov 6, 2024
Merged

Update document #81

merged 3 commits into from
Nov 6, 2024

Conversation

bluzky
Copy link
Owner

@bluzky bluzky commented Nov 6, 2024

  • Update post install message
  • Update readme to explain the different between init modes.

Summary by Sourcery

Clarify initialization modes in the README and update the post-install message to reflect the selected mode.

Enhancements:

  • Modify post-install message to provide specific instructions based on the initialization mode selected.

Documentation:

  • Update README to clarify the differences between initialization modes and provide examples for using SaladUI components in a project.

- Update post install message
- Update readme to explain the different between init modes.
Copy link

sourcery-ai bot commented Nov 6, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Enhanced documentation for initialization modes
  • Added explanation about using SaladUI as part of a project
  • Added code example showing how to import and use components
  • Added clarification about library usage
README.md
Updated component status in documentation
  • Changed Alert Dialog status from in-progress (🚧) to completed (✅)
  • Changed Collapsible status from in-progress (🚧) to completed (✅)
README.md
Improved post-installation messages
  • Added conditional message based on initialization mode
  • Updated message to explain component usage for library mode
lib/mix/tasks/salad.init.ex

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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.
Copy link

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
```
Copy link

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

@bluzky bluzky merged commit 3a39044 into main Nov 6, 2024
2 of 3 checks passed
@bluzky bluzky deleted the docs/update-post-init-message branch November 6, 2024 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant