Split client method docs out of README into docs/#225
Open
mike-engel wants to merge 3 commits into
Open
Conversation
sydneycollins-cio
previously approved these changes
Jul 2, 2026
The per-method API documentation no longer lives in the README. It is broken into one guide per client under a new docs/ folder: - docs/track.md (TrackClient) - docs/app.md (APIClient) - docs/pipelines.md (PipelinesClient) The README keeps setup and cross-cutting usage (install, client creation, retries, promise usage) and links to the three guides from a new "API reference" section. To free the docs/ folder for these hand-written guides, Typedoc's output is repointed from docs/ to typedoc/ (gitignored); .gitignore is updated to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Follows the earlier docs restructure (CDP-6279): the verifyRequestSignature documentation that landed in the README now lives in docs/webhooks.md, linked from the README's API reference list. Also registers the new guide as a Typedoc projectDocument so it renders on the generated Pages site with the others. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
The per-method API documentation is growing longer and longer, and with the upcoming push to add 100% API coverage, will make the README massive. This breaks the current API docs out into one guide per client under a new docs/ folder:
The README keeps setup and cross-cutting usage (install, client creation, retries, promise usage) and links to the three guides from a new "API reference" section.
To free the docs/ folder for these hand-written guides, Typedoc's output is repointed from docs/ to typedoc/ (gitignored); .gitignore is updated to match.
AI assisted 🤖
Note
Low Risk
Documentation and CI-only changes; no library runtime or API behavior is modified.
Overview
Moves per-method API documentation out of the README into committed guides under
docs/(track.md,app.md,pipelines.md,webhooks.md). The README now keeps install, client setup, retries, and promises, with an API reference section linking to those guides and notingnpm run docsfor Typedoc.Typedoc output is redirected from
docs/to gitignoredtypedoc/sodocs/can hold hand-written guides.typedoc.jsonregisters those guides asprojectDocuments, enablesgithubPages, and dropsPushRequestDatafromintentionallyNotExported.A new
.github/workflows/docs.ymlruns on pushes tomain(and manual dispatch):npm ci,npm run docs, uploads thetypedocartifact, and deploys to GitHub Pages.Reviewed by Cursor Bugbot for commit b8bf0be. Bugbot is set up for automated code reviews on this repo. Configure here.