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.

Sign up for GitHub

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

Jump to bottom

Improve command docs generation #414

Closed
markmichon opened this issue Jan 18, 2023 · 0 comments · Fixed by #1219
Closed

Improve command docs generation #414

markmichon opened this issue Jan 18, 2023 · 0 comments · Fixed by #1219
Assignees
@gotbadger
Labels
documentation Improvements or additions to documentation

Comments

@markmichon
Copy link
Contributor

Existing workflow

Currently, command docs are built from yaml files that are manually generated with the scripts/gen-doc-yaml.go script. This step is often overlooked leading to a divergence between live docs and cli messages.

Ideal workflow

Incorporate into the build process of the docs site and eliminate the need to store the yaml output files in git.

Possible problems

  • Requires running a go script
  • makes doc-only contributions a tad more complicated (requires go installed to run locally)
@markmichon markmichon added the documentation Improvements or additions to documentation label Jan 18, 2023
@markmichon markmichon self-assigned this Jan 18, 2023
@gotbadger gotbadger assigned gotbadger and unassigned markmichon Aug 23, 2023
@gotbadger gotbadger mentioned this issue Aug 28, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gotbadger gotbadger

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: check command docs are up to date Bearer/bearer
2 participants
@gotbadger @markmichon