From 33700fa587d8cafdd5d3e89869d11d02b4c54250 Mon Sep 17 00:00:00 2001 From: Jamie Holding Date: Wed, 15 Apr 2026 13:38:57 +0000 Subject: [PATCH] fix(docs): publish cookbook and repair README links - 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) --- README.md | 2 +- src/index.ts | 11 ++++++++++- typedoc.json | 1 + 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 423f13f..493d7e7 100644 --- a/README.md +++ b/README.md @@ -271,7 +271,7 @@ v7 is a full TypeScript rewrite. It replaces the v6 OpenAPI-Generator surface wi - **SDK documentation:** https://themeparks.github.io/ThemeParks_JavaScript/ - **API reference:** https://themeparks.github.io/ThemeParks_JavaScript/modules.html -- **Cookbook:** https://themeparks.github.io/ThemeParks_JavaScript/cookbook/ +- **Cookbook:** https://themeparks.github.io/ThemeParks_JavaScript/documents/cookbook.html - **Underlying API:** https://api.themeparks.wiki - **Issues:** https://github.com/ThemeParks/ThemeParks_JavaScript/issues - **Changelog:** [CHANGELOG.md](./CHANGELOG.md) diff --git a/src/index.ts b/src/index.ts index 0846640..0324aeb 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,7 +2,16 @@ export { ThemeParks, type ThemeParksOptions } from './client'; export { ApiError, NetworkError, RateLimitError, ThemeParksError, TimeoutError } from './errors'; export { InMemoryLruCache, type Cache } from './cache'; export type { FetchLike, FetchLikeResponse, RetryConfig, TransportOptions } from './transport'; -export type { Destinations, Entity, EntityChildren, EntityLive, EntitySchedule } from './raw'; +export { + RawClient, + type Destinations, + type Entity, + type EntityChildren, + type EntityLive, + type EntitySchedule, +} from './raw'; +export { EntityHandle } from './ergonomic/entity'; +export { DestinationsApi } from './ergonomic/destinations'; export { currentWaitTime, narrowQueues, diff --git a/typedoc.json b/typedoc.json index 6d2152a..df6e927 100644 --- a/typedoc.json +++ b/typedoc.json @@ -5,6 +5,7 @@ "exclude": ["**/node_modules/**", "src/_generated/**", "test/**", "scripts/**"], "name": "themeparks", "readme": "README.md", + "projectDocuments": ["docs/cookbook.md"], "includeVersion": true, "excludeInternal": true, "categorizeByGroup": true,