Documentation Feedback #1
Open
Conversation
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
Author
|
You can either merge this Pull Request and then work on the README.md or look at the TODOs and work on them separately. |
Author
|
Ensure all members of your team are in the 'Hardware I' team and that they are listed as collaborators on this repo. |
Collaborator
|
It appears that all students are included. Photos have been uploaded. Thanks for the feedback!Sent from my iPhoneOn 2 Dec 2024, at 10:23, Marita Georganta ***@***.***> wrote:
Ensure all members of your team are in the 'Hardware I' team and that they are listed as collaborators on this repo.
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because your review was requested.Message ID: ***@***.***>
|
Author
|
Can you check that all of the TODOs that I have put in the README are completed? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
You have done a good job following the structure of the template. I have added some TODOs on the README.me files that I would like you to resolve first. Mostly you are missing a few things on the visual side. Since you had such great material on your presentation do add the technical pics here and a nice gif from your final product. Additionally think as this documentation for someone to reproduce, so be a bit more specific on the setup (I have added the TODOs on the sections I find more relevant).