docs: add link to Sourcey-generated API reference - #2398
Open
0xConsole wants to merge 1 commit into
Open
Conversation
Juneezee
reviewed
Aug 8, 2026
Juneezee
left a comment
Member
There was a problem hiding this comment.
Doesn't https://pkg.go.dev/github.com/urfave/cli/v3 already serve as the standard documentation for this Go package?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
The existing documentation at https://cli.urfave.org is hand-written and
consists of guides, examples, and migration notes (built from the
./docsdirectory via MkDocs). It does not include a complete, type-level API
reference for the
github.com/urfave/cli/v3module — thepkg.go.devbadge inthe README links to the autogenerated Go reference, but there is no
project-hosted, navigable, searchable reference covering the full public
surface of the v3 package.
This PR adds a short Generated API Reference subsection under the
existing Documentation section of
README.md, linking to aSourcey v3.6.5 build that was generated from this
repository's real source using the
godocadapter:c6f4cf7e9223793478cfcde9b8f135cc8f86e78fonmainsourcey godoc -m . -o godoc.jsonthensourcey build -c sourcey.config.tsThe reference is a supplement to (not a replacement for) the hand-written
guides on
cli.urfave.org. It provides a searchable, type-level view thatthe existing guides do not cover, which is useful for contributors and users
who want to quickly look up a specific flag type, function signature, or
interface contract.
What changed
README.md: added a### Generated API Referencesubsection (15 lines)under the
## Documentationsection, with a maintainer-facing note thatthe generation is reproducible and the deploy can be ported to a
cli.urfave.orgsubpath if the maintainers prefer to self-host.Which issue(s) this PR fixes:
None — this is a documentation addition that does not alter any code.
Special notes for your reviewer:
sourcey godoc+sourcey buildworkflow. If the maintainers would preferto host this on a
cli.urfave.orgsubpath (or fold the generation into theexisting MkDocs build), the snapshot JSON and
sourcey.config.tsareself-contained and I am happy to port them — just leave a comment.
redeployed from any commit by re-running
sourcey godoc+sourcey build.README.mdwere modified.Testing
returns HTTP 200 and all internal page links resolve.
README.mdchange renders correctly (markdown lint clean).c6f4cf7.Release Notes