[DOCS-5093] [DOCS] Consider more control over generated CLI documentation #1429
Description
The other day I was chatting with @ndimares and mentioned that the README's CLI docs are currently 404ing, i.e.
speakeasy auth - Authenticate the CLI
Links to a page that 404s - it looks like it may have been deleted in d20794e / #1272 ?
I also chatted with Nolan about how I've written a library for giving more control over how Cobra CLI docs are generated (blog post) that may be worth a look for tweaking the way the CLI docs are generated 🤞🏼
Aside: are y'all aware that building the project fails due to references to private Go module(s)? I was going to raise a PR to share how you could use ☝🏼 but wasn't able to get make docs running:
make docs
% make docs
go run cmd/docs/main.go
go: downloading github.com/speakeasy-api/openapi-generation/v2 v2.604.4
go: downloading github.com/speakeasy-api/speakeasy-core v0.19.7
go: github.com/speakeasy-api/openapi-generation/[email protected]: reading github.com/speakeasy-api/openapi-generation/go.mod at revision v2.604.4: git ls-remote -q origin in /home/jamie/go/pkg/mod/cache/vcs/5c4825f688f1a417e33a15a2b0f7c70e583a7cfd108b8009eabdb7729b31eee2: exit status 128:
ERROR: Repository not found.
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
make: *** [Makefile:8: docs] Error 1