fix: update TypeScript api docs to use MDX by escaping the markdown#588
Merged
zastrowm merged 1 commit intostrands-agents:workstream/cms-migrationfrom Mar 4, 2026
Merged
Conversation
And add link validation to ensure all links are now valid. Previously the links being generated from TS were incorrect as they weren't getting our mdx enhancements which allow for linking to files instead of using slugs. So now instead of writing markdown files, we do a safe conversion from md -> mdx which picks up all of our fixes. - We should also port the python api docs to use this instead of our regex fixes that we're currently do; I will catch that in a follow-up. - The index page for TS is currently mis-generated because of the "telemetry" namespace that the TS SDK now generates; that's a known issue that I'll grab in a follow-up
Contributor
Documentation Preview ReadyYour documentation preview has been successfully deployed! Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-588/user-guide/quickstart/overview/ Updated at: 2026-03-04T16:43:30.354Z |
dbschmigelski
approved these changes
Mar 4, 2026
zastrowm
merged commit fd67481
into
strands-agents:workstream/cms-migration
4 of 6 checks passed
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
2 participants
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.
Description
Update TypeScript api docs to use MDX by escaping the markdown
Previously the links being generated from TS were incorrect as they weren't getting our mdx enhancements which allow for linking to files instead of using slugs. So now instead of writing markdown files, we do a safe conversion from md -> mdx which picks up all of our fixes.
Follow-ups:
As part of this PR I've also added link verification that runs as part of the build; previous to this we got a bunch of warnings about TS; now it's only showing a couple that are due to the recent telemetry changes.
Once I fix these, I'll change to this be errors
Related Issues
#441
Type of Change
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.