fix(docs): publish cookbook and repair README links#11
Conversation
- typedoc.json: add projectDocuments so docs/cookbook.md ships at /documents/cookbook.html on the deployed site. - src/index.ts: re-export RawClient, EntityHandle, DestinationsApi so TypeDoc generates their class pages (otherwise ThemeParks.raw / ThemeParks.destinations / ThemeParks.entity references dead-link). - README.md: cookbook link now points at the real generated URL. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
cubehouse
force-pushed
the
fix/docs-cookbook-url
branch
from
c856ac3 to
33700fa
Compare
There was a problem hiding this comment.
Pull request overview
Fixes missing documentation pages in the generated TypeDoc site by ensuring the cookbook is included and public-facing helper classes have generated API reference pages.
Changes:
- Add
docs/cookbook.mdto TypeDocprojectDocumentsso it’s published to the docs site. - Re-export
RawClientand ergonomic helper classes from the package entrypoint so TypeDoc generates their API pages.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| typedoc.json | Adds the cookbook as a TypeDoc project document so it is emitted during docs builds. |
| src/index.ts | Re-exports RawClient and ergonomic helpers to ensure they appear in the public API surface and TypeDoc output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "readme": "README.md", | ||
| "projectDocuments": ["docs/cookbook.md"], | ||
| "includeVersion": true, |
There was a problem hiding this comment.
The PR description/title mentions repointing the README cookbook URL, but this PR doesn't include any change to README.md. If the deployed cookbook path changed as part of this TypeDoc update, please update the README link accordingly; otherwise, consider updating the PR description/title to avoid implying a README change that isn't present.
Cookbook was 404ing on the deployed site. Add it to TypeDoc's
projectDocuments, re-export the ergonomic helper classes so their API ref pages generate, and repoint the README cookbook URL.