Skip to content

docs: document auth, pagination and development; fix package doc example - #94

Merged
ysyneu merged 1 commit into
mainfrom
docs/readme-audit
Oct 9, 2026
Merged

ysyneu merged 1 commit into
mainfrom
docs/readme-audit

Conversation

@ysyneu

@ysyneu ysyneu commented Oct 9, 2026

Copy link
Copy Markdown
Collaborator
  • README: add badges and a links row (website, API reference, pkg.go.dev, console, CLI); document NewClientWithAccessToken, pagination with ListOptions / SearchAfterCtx, and the make targets (sync-spec, generate, check, e2e).
  • doc.go (shown on pkg.go.dev): the example used IncidentListRequest, which does not exist — it is ListIncidentsRequest; link now points to www.flashduty.com.

Every Go snippet in the README was compiled against this branch.

- README: badges, links row, OAuth access-token client, ListOptions and
  SearchAfterCtx pagination, make targets and e2e setup.
- doc.go: the example referenced a nonexistent IncidentListRequest type
  (it is ListIncidentsRequest) and linked the old domain.
@ysyneu
ysyneu merged commit ce4515e into main Oct 9, 2026
4 checks passed
@ysyneu
ysyneu deleted the docs/readme-audit branch October 9, 2026 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant