Skip to content

docs: add link to Sourcey-generated API reference #2398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xConsole wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add link to Sourcey-generated API reference #2398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@ command line tools in Go featuring:
See the hosted documentation website at <https://cli.urfave.org>. Contents of
this website are built from the [`./docs`](./docs) directory.

### Generated API Reference

A machine-generated API reference for the `github.com/urfave/cli/v3` module is
published at <https://urfave-cli-sourcey-docs.vercel.app>. It is produced with
[Sourcey](https://sourcey.com) v3.6.5 using the `godoc` adapter against the v3
source tree (137 types, 24 exported functions, 44 exported variables across 4
packages), providing a navigable, searchable type-level supplement to the
hand-written guides on <https://cli.urfave.org>. The generation is fully
reproducible from a pinned commit via `sourcey godoc` + `sourcey build`, and
the deploy is a static site with no build step. If the maintainers would
prefer to host this reference on a `cli.urfave.org` subpath (or fold it into
the existing MkDocs site), the source snapshot and build config are
self-contained and easy to port — please leave a comment on the proposing PR
and I will adjust.

## Support

Check the [Q&A discussions]. If you don't find answer to your question, [create
Expand Down