-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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(cli): correct headings in argo
command's Long
description
#11980
docs(cli): correct headings in argo
command's Long
description
#11980
Conversation
- these were H1s before, and there can only be 1 H1 per page - they also _should_ be H4s, because these are under the "Synopsis", which is an H3 - this fixes some very wacky formatting in the docs as well as some HTML semantic errors Signed-off-by: Anton Gilgur <[email protected]>
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.
This should be docs instead of fix?
It is a CLI change, though in this case it impacts the generated docs more than the CLI help text itself. I labeled the PR as both Speaking of generated docs, I realized I forgot codegen here. I felt like something was missing or I ran the wrong command. Sick 😷 brain misses some details 😅, this is why I'm holding off on doing some complex code reviews right now |
Generated docs are docs change. |
Sure, but it also changes the source code / metadata of the CLI. nbd either way to be fair, but we're not currently cherry-picking docs PRs, which we will need to do for versioned docs. so we'll need some way to decipher docs PRs that are for new features vs docs PRs for existing features (most will fall into the latter, I imagine). semantically, it's generally quick to tell from a given PR, but there's no way to do that automatically right now unless we differentiate in some way |
- woops, I missed this, despite primarily looking to change that - think I forgot that `make codegen` also impacts the docs, so `make docs` doesn't quite cover everything Signed-off-by: Anton Gilgur <[email protected]>
fixed codegen |
Signed-off-by: Anton Gilgur <[email protected]>
Merged |
argo
command's Long
descriptionargo
command's Long
description
…rgoproj#11980) Signed-off-by: Anton Gilgur <[email protected]> Signed-off-by: Anton Gilgur <[email protected]>
…11980) Signed-off-by: Anton Gilgur <[email protected]> Signed-off-by: Anton Gilgur <[email protected]> (cherry picked from commit feaed7a)
Motivation
Modifications
argo
root command'sLong
descriptionVerification
Before:
After: