Skip to content

docs: improve TypeScript and tsconfig.json documentation#3007

Merged
bartlomieju merged 3 commits into
mainfrom
improve-typescript-docs
May 20, 2026
Merged

docs: improve TypeScript and tsconfig.json documentation#3007
bartlomieju merged 3 commits into
mainfrom
improve-typescript-docs

Conversation

@bartlomieju

Copy link
Copy Markdown
Member

Summary

  • Add "Configuring TypeScript compiler options" and "Using tsconfig.json with Deno" sections to the fundamentals TypeScript page — so Node.js users migrating to Deno can easily find guidance on tsconfig.json compatibility
  • Remove ~200 lines of duplicated content from the reference page (ts_config_migration.md), replacing with cross-links to the fundamentals page
  • Fix stale --config path/to/file references, replace with link to workspaces docs
  • Improve cross-linking between configuration.md, typescript.md, and ts_config_migration.md

Test plan

  • Verify the new sections render correctly on the docs site
  • Verify anchor links (#using-tsconfigjson-with-deno, #ts-compiler-options, etc.) resolve correctly
  • Check that the fundamentals TypeScript page reads well end-to-end

🤖 Generated with Claude Code

Add tsconfig.json usage guide and compiler options section to the
fundamentals TypeScript page so Node.js users can easily find it.
Remove duplicated content from the reference page and replace with
cross-links. Fix stale --config flag references.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

@lunadogbot lunadogbot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new links to #using-tsconfigjson-with-deno and #ts-compiler-options resolve to headings present after this move, and the oldUrl redirects on the reference page are preserved. Approving.

  • nit: the new directory tree fence in runtime/fundamentals/typescript.md is plain ```; tag it as text to match the docs code-block convention.

@bartlomieju bartlomieju merged commit b817055 into main May 20, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants