docs: rebuild docs - #380
Merged
Merged
Conversation
hkonsti
force-pushed
the
hkonsti/rebuild-docs
branch
2 times, most recently
from
July 2, 2026 18:56
a1432e7 to
4ee184b
Compare
Rebuild the auto-generated API reference that the old Docusaurus site had.
The legacy setup used a bespoke custom TypeDoc plugin welded to Docusaurus
(addRoute + custom React renderers). Replace it with a Nextra-native
generator: TypeDoc + typedoc-plugin-markdown emit ~500 MDX pages for
@revideo/core and @revideo/2d into src/content/api-reference/{core,2d}/.
- scripts/generate-api.mjs: runs TypeDoc over the same entry points the old
plugin documented, post-processes cross-page links to absolute extensionless
Nextra routes, names folder indexes index.md, and points "Defined in" source
links at the public redotvideo/revideo repo.
- Wire api:generate into build/dev; gitignore the derived output.
- scripts/fix-api-links.mjs: rewrite the 119 legacy /api/* links to the new
/api-reference/* routes (map built from the generated files).
- Rename the motion-canvas content section to "animations" and fix the
remaining dead internal/external links from the port.
Full next build passes (565 static pages).
The monorepo dep bump (#381) moved the repo to React 19, @types/react 19, and TypeScript 6.0. The docs were pinned to React 18 because nextra 4.2.13 depends on a React-18-only mermaid plugin (@theguild/remark-mermaid@0.2.0), which left them failing to build under the bumped root types (a Slot type skew across the @types/react 18/19 boundary) and TS 6.0. Bring the docs onto React 19 so they match the rest of the monorepo: - Bump nextra + nextra-theme-docs to 4.6.1 (its @theguild/remark-mermaid ^0.3.0 supports React 19) and move the docs app to react/@types/react 19. - global.d.ts: declare `*.css` so TS 6.0 accepts the `import "./globals.css"` side-effect import (Next only declares `*.module.css`). - next.config: transpilePackages @theguild/remark-mermaid. It is ESM-only and nextra only aliases `@theguild/remark-mermaid/mermaid` for Turbopack, so the webpack production server bundle would fail to require it at runtime. - Pin zod to 4.3.6 via a root override. zod 4.4.3 made z.custom() object keys error when the key is absent, which breaks nextra-theme-docs' LayoutPropsSchema (its Layout strips `children` before validating the schema, which lists `children`). chromium-bidi is scoped back to zod ^3 so the E2E toolchain is untouched. Docs build passes (555 static pages); npm ci is consistent on Node 20 and 22.
hkonsti
force-pushed
the
hkonsti/rebuild-docs
branch
from
July 2, 2026 19:45
4ee184b to
a6cda99
Compare
hkonsti
force-pushed
the
hkonsti/rebuild-docs
branch
from
July 2, 2026 21:32
92aac53 to
1e45cf9
Compare
hkonsti
force-pushed
the
hkonsti/rebuild-docs
branch
from
July 2, 2026 21:39
1e45cf9 to
b2e7be8
Compare
npm ci (npm 10 on CI) required conventional-commits-filter@5.0.0 and conventional-commits-parser@6.4.0, which were absent from the lock file after the commitlint upgrade. Added them via npm install --package-lock-only so all platform-specific optional binaries stay intact.
hkonsti
force-pushed
the
hkonsti/rebuild-docs
branch
from
July 2, 2026 21:45
b2e7be8 to
a503384
Compare
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.
No description provided.