Create CLI docs - #84
Merged
Merged
Conversation
chicoxyzzy
force-pushed
the
gen_docs
branch
2 times, most recently
from
July 10, 2024 23:24
f792e75 to
ea91775
Compare
chicoxyzzy
marked this pull request as draft
July 11, 2024 09:24
chicoxyzzy
force-pushed
the
gen_docs
branch
2 times, most recently
from
July 11, 2024 10:08
a102276 to
88fdefd
Compare
chicoxyzzy
marked this pull request as ready for review
July 11, 2024 10:10
chicoxyzzy
force-pushed
the
gen_docs
branch
2 times, most recently
from
July 15, 2024 16:57
87d0ad7 to
9a8e919
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a new
dispatch-docsrule to the Makefile. It builds CLI with adocsbuild flag.Markdown is generated in the
./docsdirectory with Cobra's built-in markdown generator. There's a special case where we have to wrap run command example in the usage by triple backticks to make it look properly in the markdown.This is made possible by adding aisDocsBuildflag.We can then add those docs to the developer website.