Skip to content

feat(cli): add stability annotations to generated Markdown documentation #87

Closed

Description

@kriscoleman

Description
Our CLI currently includes stability annotations (e.g., stable, experimental, deprecated) in Cobra command help templates, but these annotations are missing from the generated Markdown documentation.

This feature aims to:

  • Ensure stability information is included in Markdown documentation, maintaining parity with Cobra help output.
  • Allow customization of the command document generation process to improve flexibility and consistency.

Acceptance Criteria

  • Stability annotations are added to generated Markdown documentation.
  • Stability information in Markdown matches Cobra help output.
  • The command document generation process supports customization for future enhancements.
  • Documentation updates reflect these changes.

Implementation Notes

  • Modify the Markdown generation process to include stability annotations.
  • Ensure generated output remains clear and structured for readability.
  • Maintain consistency across CLI help and Markdown documentation.

Additional Context
This enhancement improves documentation clarity and ensures users have accurate information across all command references.

Related Issues
#76

Priority: Low

Activity

  1. added 2 commits that reference this issue on Mar 20, 2025
    2d8f0e9
    301205c
  2. added a commit that references this issue on Mar 27, 2025
    9102d13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions