Skip to content

docs(turbopack): Copy over turbopack-trace-server docs#91111

Merged
bgw merged 3 commits intocanaryfrom
bgw/tracing-docs
Mar 9, 2026
Merged

docs(turbopack): Copy over turbopack-trace-server docs#91111
bgw merged 3 commits intocanaryfrom
bgw/tracing-docs

Conversation

@bgw
Copy link
Member

@bgw bgw commented Mar 9, 2026

Rendered: https://github.com/vercel/next.js/blob/dd1cc6fba3cff5fbc38dac3ff4426b481bfcbcb5/contributing/turbopack/tracing.md

This is the content from https://turbopack-rust-docs.vercel.sh/tracing_turbopack.html with some minor updates:

  • Use GitHub Flavored Markdown for the warning block
  • Some grammar fixes/tweaks
  • Add an extra note about --release being important
  • Add a mention of pnpm next internal trace
  • Add a link to @timneutkens's youtube video
  • Change the filepath from the old confusingly named .next/trace.log to .next/trace-turbopack
  • Add a link to https://trace.nextjs.org/

@bgw bgw force-pushed the bgw/tracing-docs branch from d948c1c to dd1cc6f Compare March 9, 2026 18:42
@bgw bgw requested review from a team, icyJoseph, mmastrac and timneutkens March 9, 2026 18:45
@bgw bgw changed the title Turbopack: Copy over turbopack-trace-server docs docs(turbopack): Copy over turbopack-trace-server docs Mar 9, 2026
@bgw bgw marked this pull request as ready for review March 9, 2026 18:45
@nextjs-bot
Copy link
Collaborator

Allow CI Workflow Run

  • approve CI run for commit: 832afc5

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@bgw bgw changed the base branch from bgw/update-setup-docs to graphite-base/91111 March 9, 2026 21:49
bgw and others added 2 commits March 9, 2026 21:49
…cheme, causing it to be treated as a relative path instead of a clickable hyperlink.

This commit fixes the issue reported at contributing/turbopack/tracing.md:66

**Bug:** On line 66 of `contributing/turbopack/tracing.md`, the markdown reference link definition `[youtube-tutorial]: www.youtube.com/watch?v=PGO2szAye7A` is missing the `https://` protocol prefix. This reference link is used on line 34 as `[is available here][youtube-tutorial]`. Without the scheme, markdown renderers (including GitHub's) treat the URL as a relative path rather than an absolute URL, so clicking it would navigate to an invalid relative path like `contributing/turbopack/www.youtube.com/watch?v=PGO2szAye7A` instead of the intended YouTube video.

**Fix:** Added the `https://` prefix to make the URL `https://www.youtube.com/watch?v=PGO2szAye7A`, which is the standard format for an absolute URL that markdown renderers will correctly resolve as a clickable external hyperlink.

Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: bgw <[email protected]>
@bgw bgw force-pushed the bgw/tracing-docs branch from 832afc5 to 72260b6 Compare March 9, 2026 21:49
@bgw bgw force-pushed the graphite-base/91111 branch from 093fa1a to 15d9b71 Compare March 9, 2026 21:49
@graphite-app graphite-app bot changed the base branch from graphite-base/91111 to canary March 9, 2026 21:50
…ing.md` resolves to a non-existent path `contributing/contributing/core/developing.md`.

This commit fixes the issue reported at contributing/turbopack/tracing.md:27

**Bug:** The file `contributing/turbopack/tracing.md` contains a markdown reference link definition at line 27: `[Developing]: ../contributing/core/developing.md`. Since the file is located at `contributing/turbopack/tracing.md`, the `..` navigates up to `contributing/`, and then `contributing/core/developing.md` is appended, resulting in the resolved path `contributing/contributing/core/developing.md`. This path does not exist (confirmed via glob search), so the link is broken.

The actual target file exists at `contributing/core/developing.md` (confirmed via glob search).

**Fix:** Changed the relative link from `../contributing/core/developing.md` to `../core/developing.md`. From `contributing/turbopack/`, `..` goes up to `contributing/`, and `core/developing.md` correctly resolves to `contributing/core/developing.md`.

Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: bgw <[email protected]>
@bgw bgw force-pushed the bgw/tracing-docs branch from 72260b6 to 19f848d Compare March 9, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

created-by: Turbopack team PRs by the Turbopack team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants