-
Notifications
You must be signed in to change notification settings - Fork 62
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
docs: add documentation for oras completion #246
Conversation
The order of the commands will be correct after the PR #245 gets merged. |
cc: @TerryHowe |
Signed-off-by: Deepesha Burse <deepeshaburse@Deepeshas-MacBook-Air.local>
Signed-off-by: Deepesha Burse <deepeshaburse@Deepeshas-MacBook-Air.local>
8e85ffb
to
c15b9b4
Compare
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.
Most of the commands pages are pretty much generated from running the help on the command. The format of this doesn't really match the rest of the commands. This reads more like a how-to which I think would be useful.
True, I feel that would be more helpful. Writing documentation similar to the other commands isn't really possible for this one specifically. How about giving a 1-2 liner intro to the command under |
Co-authored-by: Terry Howe <terrylhowe@gmail.com> Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.com>
Co-authored-by: Terry Howe <terrylhowe@gmail.com> Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.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.
/lgtm
Co-authored-by: Sajay Antony <sajaya@microsoft.com> Signed-off-by: Deepesha Burse <87636253+deepeshaburse@users.noreply.github.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.
/lgtm
This PR adds documentation for
oras completion
.