-
Notifications
You must be signed in to change notification settings - Fork 29
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
[ISSUE-227] add docs
CLI command
#236
base: main
Are you sure you want to change the base?
[ISSUE-227] add docs
CLI command
#236
Conversation
--docs
CLI flag--docs
CLI flag
Hi @fainashalts, this PR is ready for review. I wasn't sure about the exact output format or the output strings so I kept them minimal to start with. Let me know if it needs to be reformatted/reworded! |
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.
Thank you for your contribution! Mostly looks good - a few suggested changes.
Also, high level, wdyt about making this a command instead of flag? supersim docs
instead of supersim --docs
. Think it might be better as a command but will leave that up to you
…s links consts to package level
Thank you for the suggestions! I reflected your suggested change from Regarding exit steps after printing the links -- in addition to invoking
Let me know how it looks! |
--docs
CLI flagdocs
CLI command
Description
Implemented
docs
CLI command for displaying the 3 available documentation page as clickable links.Tests
Manual testing. Output:
Additional context
N/A
Metadata
Resolves #227