Skip to content

Split client method docs out of README into docs/#225

Open
mike-engel wants to merge 3 commits into
mainfrom
cdp-6279
Open

Split client method docs out of README into docs/#225
mike-engel wants to merge 3 commits into
mainfrom
cdp-6279

Conversation

@mike-engel

@mike-engel mike-engel commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

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:

- 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.

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 noting npm run docs for Typedoc.

Typedoc output is redirected from docs/ to gitignored typedoc/ so docs/ can hold hand-written guides. typedoc.json registers those guides as projectDocuments, enables githubPages, and drops PushRequestData from intentionallyNotExported.

A new .github/workflows/docs.yml runs on pushes to main (and manual dispatch): npm ci, npm run docs, uploads the typedoc artifact, 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.

mike-engel and others added 3 commits July 2, 2026 16:32
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>
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.

2 participants