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

Review the Documentation #1

Open
wants to merge 41 commits into
base: main
Choose a base branch
from
Open

Review the Documentation #1

wants to merge 41 commits into from

Conversation

ph1ne4s
Copy link
Member

@ph1ne4s ph1ne4s commented Jul 25, 2022

No description provided.

Copy link
Member

@Nageshbansal Nageshbansal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. add a report in thePoster and Reportdirectory
  2. all images in readme should be of same size and you need to add these images in <p></p> tags to align them in the center
  3. add links of the mentor's github profile also

@ph1ne4s
Copy link
Member Author

ph1ne4s commented Aug 14, 2022

I have made the changes.
Please review.

@SanjeevKrishnan
Copy link
Member

I have made the changes. Please review.

@Nageshbansal Look into this and tag me once the repo is ready for merge.

Copy link
Member

@Nageshbansal Nageshbansal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Add some videos for e.g. simulation of the Model in Gazebo, and Solidworks.
  2. File names should be according to the given Documentation Guidelines.
  3. Remove log files from the src directory.
  4. Justify the text in README.md for e.g usage of the<h3> for sub-headings.
  5. Installation or Setup Instructions in README.md
  6. Decrease the dimensions of the images.
    Let me know when you're done with changes.

@ph1ne4s
Copy link
Member Author

ph1ne4s commented Aug 26, 2022

I have made the changes.
Please review.

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.

4 participants