Replace <TSDoc> component with typedoc-generated API reference pages#1611
Draft
TooTallNate wants to merge 1 commit intomainfrom
Draft
Replace <TSDoc> component with typedoc-generated API reference pages#1611TooTallNate wants to merge 1 commit intomainfrom
<TSDoc> component with typedoc-generated API reference pages#1611TooTallNate wants to merge 1 commit intomainfrom
Conversation
Replace the custom <TSDoc> component (using ts-morph at build time) with typedoc + typedoc-plugin-markdown to generate dedicated .mdx pages for each exported function, class, interface, and type alias. This gives every API symbol its own URL, making the docs more useful for AI agents reading raw markdown and enabling better cross-linking. - Add typedoc, typedoc-plugin-markdown, and typedoc-plugin-frontmatter - Create per-package typedoc configs for all 7 documented packages - Add typedoc-formatter.mjs plugin for frontmatter injection and MDX escaping - Add copy-api-docs.sh to copy generated output into Fumadocs content tree - Update 31 hand-written MDX files to replace <TSDoc> with links to generated pages - Remove docs/lib/tsdoc/ (ts-morph based component) and its dependencies - Add turbo task and build pipeline integration
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
No benchmark result files found in benchmark-results |
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests▲ Vercel Production (1 failed)hono (1 failed):
Details by Category❌ ▲ Vercel Production
✅ 🪟 Windows
❌ Some E2E test jobs failed:
Check the workflow run for details. |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
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
1 participant
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.
Summary
<TSDoc>component (which usedts-morphat build time and was invisible to AI agents reading raw MDX) with typedoc + typedoc-plugin-markdown generated pages.mdxpage with its own URLWhat changed
New infrastructure
typedoc.jsonshared config +typedoc-formatter.mjscustom plugin (frontmatter injection, MDX escaping, link cleanup)typedoc.jsonconfigs for all 7 documented packages (workflow,workflow/api,workflow/errors,@workflow/serde,workflow/next,@workflow/ai,@workflow/vitest)docs/copy-api-docs.shscript to copy generated output into the Fumadocs content treetypedocturbo task + build pipeline integration viadocs/prebuildContent changes
<TSDoc>blocks with links to the generated API reference pagesmeta.jsonfiles for sidebar navigation with "Generated API Reference" sectionsRemoved
docs/lib/tsdoc/directory (4 files: customts-morph-based TSDoc component)ts-morphandfumadocs-typescriptdependencies from docsPipeline
Verification
pnpm typedocgenerates all 112 pages across 7 packagespnpm --filter docs buildsucceeds with 651 pages, no errors<TSDoc>references remain in any MDX files