Add package documentation for pkg.go.dev directories view#14
Merged
Conversation
- Create module-level doc.go for pkg.go.dev overview page - Add doc.go to 11 internal packages missing package documentation: rules, config, checks, scan, correlation, enrich, ingest, report, provenance, completion, mcp, corpus - Consolidate daemon package doc into doc.go (was duplicated across client.go and daemon.go with different descriptions) Closes #13 Made-with: Cursor
GITHUB_TOKEN API calls do not fire pull_request:labeled events, so the auto-label workflow adding ok-to-test never triggered CI. Fix by adding opened back to pull_request types and allowing opened events to bypass the label check (the PR author has push access). Fork PRs from untrusted users are still gated by ok-to-test on synchronize and labeled events. Made-with: Cursor
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.
Summary
doc.goat repo root for the pkg.go.dev overview pagedoc.gowith package-level doc comments to 11 internal packages that were missing them:rules,config,checks,scan,correlation,enrich,ingest,report,provenance,completion,mcp,corpusdaemonpackage doc into a singledoc.go(was duplicated with different descriptions inclient.goanddaemon.go)Before
pkg.go.dev directories view showed empty descriptions for most internal packages.
After
All 18 packages (plus the module root) have doc comments that will appear in the pkg.go.dev directories table and individual package pages.
Verification
go vet ./...passesgo test ./...passes (all 18 packages)Closes #13
Made with Cursor