Skip to content

Comments

docs: updates cli docs gen script#882

Merged
KeithB-Temporal merged 5 commits intomainfrom
cli-docs-gen-improvement
Dec 9, 2025
Merged

docs: updates cli docs gen script#882
KeithB-Temporal merged 5 commits intomainfrom
cli-docs-gen-improvement

Conversation

@lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Dec 5, 2025

What was changed

  • Updated the script to generate the CLI docs

Why?

The old reference had a big global flag duplication and the think format was slightly hard to read. I modified the script to:

  • use a table format to make the content more structured and readable
  • reduce the duplication of the global flags. Instead of duplicating dozens of lines with every subcommand, we now only mention the global flags once per page and link to it from every subcommand.

Checklist

  1. Closes

  2. How was this tested:

  • I ran the script to generate the docs and previewed them here:

📖 Docs PR preview links

  1. Any docs updates needed?

- Introduced a globalFlagsMap to collect and write global flags for commands.
- Updated the docWriter to include a new method for writing global flags sections at the end of each file.
- Refactored option writing to improve clarity and consistency in the generated documentation.

This change allows for better organization and presentation of command options in the generated documentation.
@lennessyy lennessyy requested review from a team as code owners December 5, 2025 00:32
@CLAassistant
Copy link

CLAassistant commented Dec 5, 2025

CLA assistant check
All committers have signed the CLA.

@lennessyy lennessyy marked this pull request as draft December 5, 2025 00:32
@lennessyy lennessyy marked this pull request as ready for review December 5, 2025 16:37
@lennessyy lennessyy marked this pull request as draft December 5, 2025 16:37
@lennessyy lennessyy marked this pull request as ready for review December 5, 2025 20:40
@KeithB-Temporal KeithB-Temporal merged commit bdf6b67 into main Dec 9, 2025
8 checks passed
@KeithB-Temporal KeithB-Temporal deleted the cli-docs-gen-improvement branch December 9, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants