Repository navigation
docs: Remove private package details and a stale credit fact - #120
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 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/sdkclient-shape documentation and updated SDK references to recommendfetch. - 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: |
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.

Some pages described packages that are not public, and one changelog entry needed a note about a retired offer.
What changed:
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: