Skip to content

chore: Add twoslash to test code snippets for correctness - #596

Merged
davidkna-sap merged 19 commits into
mainfrom
doctest
Aug 4, 2026
Merged

chore: Add twoslash to test code snippets for correctness#596
davidkna-sap merged 19 commits into
mainfrom
doctest

Conversation

@marikaner

@marikaner marikaner commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Note, that there were around 30 actual errors in the code samples, that are solved by this PR.

Also note, I forgot to mention this in the review: To have the latest version of the SDK available I am using the canary versions of the AI SDK. As they cannot be updated by dependabot due to the nature of pre versions, I created an additional workflow that runs nightly. This could be changed to:

  • run on PRs instead (like auto-doc)
  • report issues to slack, so we notice them early on

@marikaner
marikaner force-pushed the doctest branch 2 times, most recently from 0761a96 to b5bcac6 Compare July 22, 2026 07:12
@marikaner
marikaner requested a review from a team July 27, 2026 08:23
Comment thread docs-js/ai-core/ai-api.mdx Outdated
Comment thread .github/workflows/update-js-sdk-deps.yml Outdated
Comment thread docs-js/tsconfig.json
@marikaner
marikaner marked this pull request as ready for review July 30, 2026 10:17
@marikaner
marikaner requested a review from InjunPark-sap August 3, 2026 08:59
InjunPark-sap
InjunPark-sap previously approved these changes Aug 3, 2026
@marikaner
marikaner changed the base branch from main to update-node August 3, 2026 18:24
@marikaner
marikaner requested a review from InjunPark-sap August 3, 2026 18:30
InjunPark-sap
InjunPark-sap previously approved these changes Aug 4, 2026

@InjunPark-sap InjunPark-sap left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Base automatically changed from update-node to main August 4, 2026 08:17
davidkna-sap
davidkna-sap previously approved these changes Aug 4, 2026
* chore: string twoslash cuts manually

* add changes from review

* add other notation

* rename plugin

* wip

* rename mjs => js

* fix name

* oops
@davidkna-sap
davidkna-sap merged commit fc08b64 into main Aug 4, 2026
7 checks passed
@davidkna-sap
davidkna-sap deleted the doctest branch August 4, 2026 13:05
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.

3 participants