docs: add browsable Sourcey API reference link - #227
Open
Luvi-1 wants to merge 1 commit into
Open
Conversation
Adds a badge and Resources entry linking to a searchable Sourcey-generated API reference site for fp-go, complementing the existing pkg.go.dev docs with a richer browsing experience (sidebar navigation, full-text search, dark mode). Generated with Sourcey 3.6.5 from source at commit c52889e. Signed-off-by: hibutwhy <112614297+hibutwhy@users.noreply.github.com>
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
1 participant
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
Adds two small additions to the README:
Why
The current docs point only to pkg.go.dev, which is functional but not great for browsing. The Sourcey API reference offers:
Generated with Sourcey 3.6.5 from source at commit . No code changes — README only.
Preview
Live site: https://luvi-1.github.io/fp-go-docs/