docs(typescript): custom doc generation router with semantic structure and MDX safety#728
Merged
Conversation
✅ Heimdall Review Status
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
from
b5dcccb to
7c00a90
Compare
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
from
7c00a90 to
b4f0586
Compare
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
2 times, most recently
from
07bbb2c to
a19713f
Compare
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
3 times, most recently
from
a05ad7d to
2fa9878
Compare
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
from
2fa9878 to
064da0b
Compare
sddioulde
approved these changes
Jun 18, 2026
…ructure Adds typedoc-router-backend.mjs — a custom TypeDoc router that uses existing @module tags (Client, Accounts, Actions, Types, etc.) to organize generated docs into semantic directories instead of TypeDoc's default flat kind-based names (Client.Class.EvmClient.mdx). Additional changes to ensure Mintlify compatibility: - Switch parametersFormat, propertiesFormat, typeDeclarationFormat to "list" (table format breaks Mintlify's strict MDX build when cells contain TypeScript generics or template literals like ${string}) - Add ts-frontmatter.mjs to all typedoc configs so every page gets title/sidebarTitle frontmatter (required for Mintlify to render) - Strip .mdx from generated cross-links; lowercase kind-based fallback directory names to avoid case-sensitivity 404s on Linux build servers - Escape @pattern pipe chars and bare {expr} patterns to prevent MDX JSX parse failures - Set skipErrorChecking: true (suppresses unrelated node_modules TS errors) - Remove flattenOutputFiles (was collapsing the subdirectory structure) - Set membersWithOwnFile to [Class, Function, Enum, Variable, TypeAlias] Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
jazz-cb
force-pushed
the
jj/sdk-docs-router
branch
from
064da0b to
37b246b
Compare
kkuhnen
approved these changes
Jun 18, 2026
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
5 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
Tests
Checklist
A couple of things to include in your PR for completeness: