docs/update docs #4
Merged
Conversation
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
Owner
cboone
commented
Feb 7, 2026
cboone
commented
- docs: add pkg.go.dev links to documentation
- docs: update README
Add a package reference link to the README documentation section and update all docs/ guides to reference the pkg.go.dev page alongside the existing go doc command.
There was a problem hiding this comment.
Pull request overview
Documentation-focused update to make the API reference easier to find by linking to pkg.go.dev, along with minor README formatting/content tweaks to improve readability.
Changes:
- Add pkg.go.dev package-reference links across the docs (with
go docas an alternative). - Refresh README intro wording and improve Markdown formatting (typed code fences, matcher table alignment).
- Add a “Package reference” link to the README Documentation section.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/TROUBLESHOOTING.md | Adds pkg.go.dev link alongside go doc for API signatures. |
| docs/SNAPSHOTS.md | Adds pkg.go.dev link alongside go doc for API signatures. |
| docs/PATTERNS.md | Adds pkg.go.dev link alongside go doc for API details. |
| docs/MATCHERS.md | Adds pkg.go.dev link alongside go doc for function signatures. |
| docs/GETTING-STARTED.md | Adds pkg.go.dev link alongside go doc for function signatures. |
| docs/ARCHITECTURE.md | Adds pkg.go.dev link alongside go doc for API signatures. |
| README.md | Updates tagline/intro, improves Markdown formatting, and adds pkg.go.dev “Package reference” link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.