Add cli command to build docs

[omkar-foss]

Closes #15.

This PR adds a new command ai-detection-action docs, details in help snippet below.

To avoid clutter here I've pushed generated docs separately to this commit in my fork, you can preview those markdown docs here.

$ ai-detection-action docs --help
Build docs in markdown, manpages, rest formats

Usage:
  ai-detection docs [flags]

Examples:
  # simply build markdown docs at default output dir (./docs/cli)
  ai-detection-action docs

  # build rest docs at default output dir
  ai-detection-action docs --format rest

  # build manpages docs at a specific 'documentation' dir
  ai-detection-action docs --format manpages --out ./documentation

Flags:
      --format string   markdown|manpages|rest (default "markdown")
  -h, --help            help for docs
      --out string      output directory (default "./docs/cli")

[andrew]

LGTM

[MoralCode]

ai-detection-action feels like a pretty long name to expect people to type on the CLI. any ways to make this shorter?

[omkar-foss]

any ways to make this shorter?

How about aida? (ai)-(d)etection-(a)ction

[MoralCode]

this is for the golang core, which is technically separate from the github action wrapper.

what if we had the CLI name be disclosure?

[omkar-foss]

what if we had the CLI name be disclosure?

Looks good, could it be a bit more informative like disclosure-cli or ai-disclosure-cli?

[MoralCode]

what if we had the CLI name be disclosure?

Looks good, could it be a bit more informative like disclosure-cli or ai-disclosure-cli?

i feel like if people have downloaded this project and are using it as a CLI, they may alrady know what its about. IMO if we want to be extra clear, we should make a note of this projects purpose in the --help menu (i.e. where most CLI users will go if they need help, dont know what this program does or how to use it).

I think the shorter, easier to remember binary name is going to make it easier to use than the additional verbosity (especially when the help menu is a better place for that verbosity)

[omkar-foss]

Sure if we're making --help comprehensive along with short cli name (disclosure) then it sounds good to me, thanks for elaborating

[omkar-foss]

Sure if we're making --help comprehensive along with short cli name (disclosure) then it sounds good to me, thanks for elaborating

@MoralCode I've created issue #34 based on our conversation above in this thread.

[MoralCode]

Repo has been renamed to support #34. Can you:

1. update the various imports in this project to use the new name
2. make sure the binaries now build as disclosure
3. ensure any changes that need to be made in this PR get made (i.e. add the help text to explain the project?

[omkar-foss]

1 & 2 from this comment done in #36.

Regarding 3:

add the help text to explain the project

I think adding help text is a good first issue for newcomers. Would be nice if we create a separate issue for this.

[MoralCode]

sounds good. this should probably be rebased on top of the renaming changes to pre-emptively deal with any merge conflicts

[omkar-foss]

sounds good. this should probably be rebased on top of the renaming changes to pre-emptively deal with any merge conflicts

Done, rebased with main, thanks.

[omkar-foss]

@andrew @MoralCode quick nudge, this pr is ready to review & merge, thanks.

[andrew]

Would be good to have some tests for this

[omkar-foss]

Would be good to have some tests for this

Sure will add some

[omkar-foss]

Would be good to have some tests for this

Sure will add some

@andrew Have added tests, check it out when possible, thanks

[MoralCode]

Havent tested directly but agree with the direction!