-
Notifications
You must be signed in to change notification settings - Fork 1
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 readme #5
base: master
Are you sure you want to change the base?
Conversation
Reviewer's Guide by SourceryThe PR enhances the repository's README.md by adding comprehensive documentation about the Badge Magic LED casing project. The changes include adding sections for related repositories, purchasing information, required tools, and visual documentation through rendered and actual product images. 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 @kienvo - I've reviewed your changes - here's some feedback:
Overall Comments:
- There are a couple of minor text issues to fix: 'Redered' should be 'Rendered' in the image section headers, and 'get a the board' should be 'get the board' in the Buy Device section.
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.
README.md
Outdated
## Images | ||
|
||
### Redered image |
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): Fix typo: 'Redered' should be 'Rendered'
README.md
Outdated
## Buy Device | ||
|
||
You can get a the board at the [FOSSASIA Shop](https://fossasia.com). |
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): Remove redundant article 'a' in sentence
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 @kienvo - 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.
## Buy Device | ||
|
||
You can get a board at the [FOSSASIA Shop](https://fossasia.com). |
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): Consider providing a more specific shop link
The current link is to the main website. A direct link to the product page would be more helpful for users looking to purchase.
You can get a board at the [FOSSASIA Shop](https://fossasia.com). | |
You can get a board at the [FOSSASIA Shop](https://shop.fossasia.com/collections/pslab). |
## Tools | ||
|
||
[FreeCad](https://www.freecad.org/downloads.php) |
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.
nitpick (documentation): Fix capitalization of FreeCAD
Update readme and add some preview images.
Summary by Sourcery
Documentation: