docs: add godoc examples, package docs, llms.txt, and ghinstallation comparison - #54
Merged
Conversation
…comparison - doc.go: full package documentation with usage overview for pkg.go.dev - example_test.go + webhook/example_test.go: runnable Example functions rendered on pkg.go.dev for every constructor and the webhook API - llms.txt: concise machine-readable library summary for AI coding assistants that fetch repo docs at generation time - README: honest feature comparison with ghinstallation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 4 4
Lines 325 325
=======================================
Hits 306 306
Misses 12 12
Partials 7 7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
One canonical quick-start instead of near-duplicate full programs; reference detail now lives in doc.go, pkg.go.dev examples, and llms.txt. Version-specific marketing removed; comparison table kept.
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.
Description
Improves discoverability and documentation quality for both humans and AI coding assistants:
doc.go— full package documentation rendered on the pkg.go.dev landing page: authentication chain overview, token caching and proactive refresh, external signer (KMS/HSM) support, Enterprise URLs, and a pointer to thewebhooksubpackage. The short package comment moves out ofauth.go.example_test.go/webhook/example_test.go— runnableExamplefunctions for every constructor and the webhook API. These render as copy-pasteable examples on pkg.go.dev.llms.txt— concise machine-readable library summary (API surface, when to choose this library, canonical snippet) for AI coding assistants that fetch repo docs at generation time.ghinstallation, fact-checked against its source (it does refresh proactively and does support custom signers; the table says so).Type of Change
Testing
go test ./...; example functions are compile-verified by the test suite)Documentation