(DOCS) Add CLI reference documentation #120
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This will need to be updated after #114 merges. |
|
Updated to include changes from #114 and examples for each command. |
This change adds reference documentation for the `dsc` CLI. It references the output schemas, which are being added in #94.
Merged
SteveL-MSFT
approved these changes
Aug 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This change adds reference documentation for the
dscCLI. It references the output schemas, which are being added in #94.PR Context
I did some initial investigation on auto-generating reference documentation from the code and found little useful support for exporting Markdown. The best option seems to be exporting to ROFF and then converting. For now, I've hand-written the documentation and we can investigate porting the docs into the structs that define the application's arguments and commands in the future.