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

[COMPLETED]DOCUMENTATION Update #19

Merged
merged 11 commits into from
Dec 26, 2024
Merged

[COMPLETED]DOCUMENTATION Update #19

merged 11 commits into from
Dec 26, 2024

Conversation

RD-Tarun
Copy link
Contributor

#3 - PR Issue Link

@Ashrockzzz2003 I've created the documentation for the CLI tool in OSS Format as well. Please review the changes and let me know if any further modifications are needed.

Thank You!!

@Ashrockzzz2003 Ashrockzzz2003 linked an issue Dec 24, 2024 that may be closed by this pull request
2 tasks
Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

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

Please move the changes to README.md and delete documentation.md. That is where it's meant to be.

Add a point about the requirement of Amrita WiFi/VPN to access the tool in usage as a separate step.

@RD-Tarun
Copy link
Contributor Author

alright!!

README.md Outdated Show resolved Hide resolved
Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

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

So far looks good @RD-Tarun
Consider adding Amrita Logo, Go logo, and possibly some relevant shield icons.

@RD-Tarun
Copy link
Contributor Author

done, please check it out @Ashrockzzz2003 @Abhinav-ark

@Ashrockzzz2003 Ashrockzzz2003 self-requested a review December 25, 2024 14:57
Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

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

Thanks for linking my portfolio instead of GitHub! : )

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@Ashrockzzz2003 Ashrockzzz2003 self-requested a review December 26, 2024 03:04
Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@Abhinav-ark Abhinav-ark left a comment

Choose a reason for hiding this comment

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

LGTM.

@Abhinav-ark
Copy link
Member

/bounty 50 @RD-Tarun

@Abhinav-ark Abhinav-ark merged commit cd0d721 into CSE-25:main Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add DOCUMENTATION on how to use this tool.
3 participants