Skip to content

docs: improve Go library developer experience - #261

Merged
skyoo2003 merged 3 commits into
mainfrom
feat/go-library-developer-experience
Sep 15, 2026
Merged

skyoo2003 merged 3 commits into
mainfrom
feat/go-library-developer-experience

Conversation

@skyoo2003

@skyoo2003 skyoo2003 commented Sep 15, 2026 •

Copy link
Copy Markdown
Owner

Description

Improve ACOR product experience for Go library users without changing the public API. The README and Quick Start now use context-first construction and operations, the API reference explains operation selection and typed error handling, and the existing examples demonstrate production-oriented context usage.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Test update

Checklist

  • Tests pass (make test)
  • Vet/make vet
  • Linting passes (make lint)
  • Build succeeds (make build)
  • Documentation updated if needed
  • Changelog fragment added (not included because this PR changes documentation and examples only; no runtime or release behavior)
  • Commit messages follow guidelines

Additional Notes

  • Verification also included doccheck for 22 Markdown Go blocks, builds for all three examples, and API snapshot verification with no public API diff.
  • The local shell had a stale GOROOT pointing to Go 1.26.7 while the active tool was Go 1.27.1, so verification commands unset GOROOT for a consistent toolchain.
  • The approved design and implementation plan remain excluded from commits and this PR.

@github-actions github-actions Bot added documentation go Pull requests that update Go code labels Sep 15, 2026
@skyoo2003
skyoo2003 merged commit 3f958b9 into main Sep 15, 2026
11 checks passed
@skyoo2003
skyoo2003 deleted the feat/go-library-developer-experience branch September 15, 2026 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation go Pull requests that update Go code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant