Skip to content

Make docs for cli #234

Closed
Closed
@evshubbs

Description

@evshubbs
No description provided.

Activity

changed the title [-]Make docs for clu[/-] [+]Make docs for cli[/+] on May 11, 2023
tstirrat15

tstirrat15 commented on Nov 21, 2024

@tstirrat15
Contributor

I did some research on this and we actually can get it relatively for free from cobra internals: https://pkg.go.dev/github.com/spf13/cobra/doc#GenMarkdownTree

The lift here would be:

  1. Write a script that invokes the above, perhaps using mage
  2. Write automation that runs that script and diffs it, likely on merge
  3. Write automation that submits it to the docs repo when the diff changes

This would solve authzed/docs#260 as well.

authzedbot

authzedbot commented on Nov 21, 2024

@authzedbot
added
area/CLIAffects the command line
and removed
area/CLIAffects the command line
on Jan 7, 2025
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

      Participants

      @tstirrat15@authzedbot@evshubbs

      Issue actions

        Make docs for cli · Issue #234 · authzed/zed