Go Doc for Agents

Make the exported API usable from package and symbol documentation without requiring a separate guide. Put the smallest useful recipe in doc comments and verify it with Go examples.

Steps

1. Read repository instructions, the supported Go version, and existing documentation conventions. Identify the requested packages and preserve unrelated changes.
2. Read exported declarations, implementations, tests, and current examples. Establish actual behavior before describing it. Flag unresolved contracts instead of inventing guarantees.
3. Read the syntax reference before writing comments. Read the examples reference when adding or repairing usage recipes.
4. Write one package overview, usually in doc.go. Name the use case, recommended entry points, shortest setup/use/cleanup sequence, and relevant alternatives. Include an indented code recipe with the real import path so plain go doc exposes basic usage.
5. Document each in-scope exported symbol's contract at its declaration. Keep each symbol understandable when queried alone. Use the contract table below to select relevant details.
6. Add or update external-package examples for the important recipes. Reuse existing examples when they already cover the workflow. Keep the short comment recipe consistent with its compiled example.
7. Format changed Go files using the repository's formatter. Inspect package and symbol output with go doc. Run example tests and the affected package tests. Compile-check comment recipes too; they are not tested automatically.
8. Review the diff for unsupported promises, broken symbol links, stale examples, and unrelated edits. Report changed packages and verification results.