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 each @CliCommand (annotation) to ensure the command specifies “help” (attribute) #17

Open
gregturn opened this issue Dec 13, 2022 · 0 comments
Labels
type: documentation A documentation update

Comments

@gregturn
Copy link
Contributor

As suggested by @jxblum:

  • Include a brief summary of the commands actions and expected outcome.
  • Optionally, include a link referring to additional (external) documentation used to supplement the help information with additional details, such as how to respond in a failure case.

“Contextual-based help” will potentially go a long way in adequately documenting the build/release process in order to help guide SD veterans and newcomers, alike, navigate a build and release process across environments.

@gregturn gregturn added type: documentation A documentation update type: enhancement A general enhancement labels Dec 13, 2022
@mp911de mp911de removed the type: enhancement A general enhancement label Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants