Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(turbopack): build more docs #61977

Merged
merged 4 commits into from
Feb 13, 2024
Merged

docs(turbopack): build more docs #61977

merged 4 commits into from
Feb 13, 2024

Conversation

kwonoj
Copy link
Contributor

@kwonoj kwonoj commented Feb 13, 2024

What

This PR changes setup for the turbopack documentation.

Long story in short, we want to 2 types of documentation: one for high level description (archtecture, etcs) and another for the api doc. rustdoc / cargo doc unfortunately doesn't support to integrate both easily.

PR adds mdbook setup to workaround those - instead of using rustdoc's index as entrypoint, mdbook becomes an entrypoint to rustdoc. This allows to host plain text document, and also able to access full rustdoc pages.

preview: https://turbopack-rust-docs-b6qta4xdq.vercel.sh/
rustdoc: https://turbopack-rust-docs-b6qta4xdq.vercel.sh/rustdoc/index.html

Closes PACK-2475
Closes PACK-2468

@ijjk ijjk added Font (next/font) Related to Next.js Font Optimization. Turbopack Related to Turbopack with Next.js. created-by: Turbopack team PRs by the turbopack team type: next labels Feb 13, 2024
@ijjk
Copy link
Member

ijjk commented Feb 13, 2024

Stats from current PR

Default Build
General
vercel/next.js canary vercel/next.js docs-packages Change
buildDuration 11.9s 12s N/A
buildDurationCached 6.6s 5.1s N/A
nodeModulesSize 196 MB 196 MB
nextStartRea..uration (ms) 412ms 405ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js docs-packages Change
3f784ff6-HASH.js gzip 53.5 kB 53.5 kB N/A
423.HASH.js gzip 185 B 181 B N/A
68-HASH.js gzip 30 kB 30 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB
main-app-HASH.js gzip 238 B 240 B N/A
main-HASH.js gzip 31.9 kB 31.9 kB N/A
webpack-HASH.js gzip 1.7 kB 1.7 kB
Overall change 46.9 kB 46.9 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js docs-packages Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js docs-packages Change
_app-HASH.js gzip 194 B 195 B N/A
_error-HASH.js gzip 182 B 181 B N/A
amp-HASH.js gzip 502 B 501 B N/A
css-HASH.js gzip 320 B 322 B N/A
dynamic-HASH.js gzip 2.5 kB 2.5 kB N/A
edge-ssr-HASH.js gzip 255 B 256 B N/A
head-HASH.js gzip 350 B 349 B N/A
hooks-HASH.js gzip 368 B 369 B N/A
image-HASH.js gzip 4.2 kB 4.2 kB N/A
index-HASH.js gzip 257 B 256 B N/A
link-HASH.js gzip 2.67 kB 2.67 kB N/A
routerDirect..HASH.js gzip 310 B 311 B N/A
script-HASH.js gzip 384 B 383 B N/A
withRouter-HASH.js gzip 306 B 308 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 106 B 106 B
Client Build Manifests
vercel/next.js canary vercel/next.js docs-packages Change
_buildManifest.js gzip 483 B 484 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js docs-packages Change
index.html gzip 527 B 527 B
link.html gzip 541 B 539 B N/A
withRouter.html gzip 523 B 522 B N/A
Overall change 527 B 527 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js docs-packages Change
edge-ssr.js gzip 94.4 kB 94.4 kB N/A
page.js gzip 150 kB 150 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js docs-packages Change
middleware-b..fest.js gzip 621 B 624 B N/A
middleware-r..fest.js gzip 151 B 149 B N/A
middleware.js gzip 47.4 kB 47.4 kB N/A
edge-runtime..pack.js gzip 1.94 kB 1.94 kB
Overall change 1.94 kB 1.94 kB
Next Runtimes
vercel/next.js canary vercel/next.js docs-packages Change
app-page-exp...dev.js gzip 166 kB 166 kB
app-page-exp..prod.js gzip 95.5 kB 95.5 kB
app-page-tur..prod.js gzip 97.2 kB 97.2 kB
app-page-tur..prod.js gzip 91.7 kB 91.7 kB
app-page.run...dev.js gzip 136 kB 136 kB
app-page.run..prod.js gzip 90.2 kB 90.2 kB
app-route-ex...dev.js gzip 22 kB 22 kB
app-route-ex..prod.js gzip 14.9 kB 14.9 kB
app-route-tu..prod.js gzip 14.9 kB 14.9 kB
app-route-tu..prod.js gzip 14.6 kB 14.6 kB
app-route.ru...dev.js gzip 21.7 kB 21.7 kB
app-route.ru..prod.js gzip 14.6 kB 14.6 kB
pages-api-tu..prod.js gzip 9.43 kB 9.43 kB
pages-api.ru...dev.js gzip 9.7 kB 9.7 kB
pages-api.ru..prod.js gzip 9.43 kB 9.43 kB
pages-turbo...prod.js gzip 22.1 kB 22.1 kB
pages.runtim...dev.js gzip 22.7 kB 22.7 kB
pages.runtim..prod.js gzip 22.1 kB 22.1 kB
server.runti..prod.js gzip 49.9 kB 49.9 kB
Overall change 925 kB 925 kB
Commit: 1b73f1c

@ijjk
Copy link
Member

ijjk commented Feb 13, 2024

Tests Passed

@kwonoj kwonoj force-pushed the docs-packages branch 2 times, most recently from f3ac5a6 to 63ba0da Compare February 13, 2024 08:28
@kwonoj kwonoj marked this pull request as ready for review February 13, 2024 08:42
@kwonoj kwonoj requested review from ismaelrumzan and leerob and removed request for a team February 13, 2024 08:42
@kwonoj kwonoj merged commit 1dc3c01 into canary Feb 13, 2024
70 checks passed
@kwonoj kwonoj deleted the docs-packages branch February 13, 2024 20:17
@github-actions github-actions bot added the locked label Mar 9, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Turbopack team PRs by the turbopack team Font (next/font) Related to Next.js Font Optimization. locked Turbopack Related to Turbopack with Next.js. type: next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants