Skip to content

docs: Remove private package details and a stale credit fact - #120

Merged
johnxie merged 1 commit into
mainfrom
chore/public-text-cleanup
Nov 19, 2026
Merged

johnxie merged 1 commit into
mainfrom
chore/public-text-cleanup

Conversation

@johnxie

@johnxie johnxie commented Nov 18, 2026

Copy link
Copy Markdown
Member

Some pages described packages that are not public, and one changelog entry needed a note about a retired offer.

What changed:

  • The TypeScript SDK pages showed the planned code shape of a client that is not published (the npm registry returns 404 for it). The planned-shape section is removed. The intro, the cookbook types section, three table rows, one link line and the llms.txt line now say to call the API with the built-in fetch. The working fetch examples stay.
  • The March 28, 2026 changelog entry and the March index described the internal repository layout and the private registry of the embed package. The entry now names the agent chat embed widget and keeps the user-facing security changes.
  • The July 16, 2026 changelog entry keeps its history. One new line says that the welcome credit offer ended, that the Free plan now starts with 0 AI credits, and links the pricing page.

Not changed, by the GitBook rule (no page title, heading other than the one changelog heading above, front matter or hint block edits): three hint blocks and one front matter description still say that the SDK is in preview and not on npm, and the March 28 front matter description still names the embed package.

Checks:

  • node .github/scripts/check-facts.mjs --self-test and --base origin/main pass (8 files, 0 problems).
  • node .github/scripts/check-twins.mjs --offline passes.
  • No file is renamed or moved.

Copilot AI lite review requested due to automatic review settings November 18, 2026 23:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The cookbook still contains stale references to an unpublished preview client that contradict its current fetch-only guidance.

1 open issue
What changed in this PR

This PR updates documentation to remove unpublished TypeScript SDK implementation details, standardize guidance around the built-in fetch, clarify the March embed security changelog entry, and record the end of the Free-plan welcome credit offer.

Changes:

  • Removed the planned @taskade/sdk client-shape documentation and updated SDK references to recommend fetch.
  • Reworded the March 28 changelog entry to describe the agent chat embed widget without private package details.
  • Added a July changelog note that Free plans now start with 0 AI credits.
File Description
updates-and-timeline/​changelog-2026/​march-2026/​README.md Updates the March release index entry for the agent chat embed widget.
updates-and-timeline/​changelog-2026/​march-2026/​march-28-2026.md Removes private package and registry details from the embed security changelog entry.
updates-and-timeline/​changelog-2026/​july-2026/​july-16-2026.md Records the end of the Free-plan welcome credit offer and the new 0-credit starting balance.
llms.txt Updates the TypeScript integration summary to recommend the built-in fetch.
help-and-support/​index/​07_api.md Replaces the generated-client description with built-in fetch guidance.
apis-living-system-development/​sdk-quickstart.md Removes the planned client-shape section and clarifies the fetch-based integration approach.
apis-living-system-development/​sdk-cookbook.md Updates TypeScript response-types guidance to use locally declared types.
apis-living-system-development/​developers/​README.md Updates the developer-surface overview to describe fetch-based TypeScript integrations.
apis-living-system-development/​developers/​api.md Updates TypeScript API descriptions and access tables.
apis-living-system-development/​developer-home.md Updates the developer-home TypeScript SDK listing to describe the fetch-based approach.

Review effort: Lite

Declare the shapes that you read. Then the compiler finds a wrong field.

The future generated client will export `TaskadePublicApi` plus request and response types. Until then, declare your own:
Declare a type for each response that you read:
@johnxie
johnxie merged commit 003c754 into main Nov 19, 2026
8 checks passed
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