Skip to content

feat: Introduce sloctl docs auto generation - #179

Merged
nieomylnieja merged 16 commits into
mainfrom
introduce-docs-generation
Sep 22, 2026
Merged

nieomylnieja merged 16 commits into
mainfrom
introduce-docs-generation

Conversation

@nieomylnieja

@nieomylnieja nieomylnieja commented Aug 2, 2024 •

Copy link
Copy Markdown
Collaborator

Motivation

The command reference duplicated CLI help and required separate updates. Generating reference data from Cobra keeps command descriptions, syntax, examples, and flags tied to the CLI source.

Summary

  • Added a deterministic JSON export of public commands, including short descriptions for the summary table, long help, examples, and flags. Non-runnable parent commands omit command syntax.
  • Expanded CLI help with configuration, input handling, and review status guidance from the existing reference, and removed the obsolete MCP experimental warning.
  • Added generated-reference checks to releases and documentation synchronization after successful official releases, with bounded retries and support for resuming interrupted monitoring.
  • Bound dispatch to the sloctl-docs-dispatch environment and limited its GitHub App token to Actions write access.

Related changes

The compatible documentation renderer and update workflow must be available before the first release uses synchronization. A documentation update failure does not change the completed CLI release.

Testing

  • Added offline unit coverage for deterministic exports, command hierarchy, short and long descriptions, hidden commands and flags, parent-command syntax, flag formatting, and file-write failure handling. Unit coverage avoids requiring the Nobl9 API for the generator.
  • Live release dispatch and downstream deployment have not been exercised.

@n9-machine-user n9-machine-user added enhancement New feature or request go minor labels Aug 2, 2024
@nieomylnieja nieomylnieja changed the title feat: Introduce sloctl docs atuo generation feat: Introduce sloctl docs auto generation Sep 19, 2024
@nieomylnieja
nieomylnieja force-pushed the introduce-docs-generation branch from 7419064 to cf762ff Compare August 3, 2026 13:01
@nieomylnieja
nieomylnieja marked this pull request as ready for review September 15, 2026 12:29
Comment thread docs/DEVELOPMENT.md Outdated
Comment thread internal/completion.go
@nieomylnieja
nieomylnieja merged commit fc5a4d2 into main Sep 22, 2026
4 checks passed
@nieomylnieja
nieomylnieja deleted the introduce-docs-generation branch September 22, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request go minor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants