docs: improve docs #4947

ahnpnl · 2025-07-20T09:11:15Z

Summary

See commits

Test plan

Green CI

Does this PR introduce a breaking change?

Yes
No

Other information

N.A.

Summary by CodeRabbit

Documentation
- Updated documentation links in multiple introduction pages to explicitly reference the correct markdown files.
- Removed outdated documentation for versions 26.5, 27.0, and 27.1, including guides, troubleshooting, migration, and configuration option references.
- Shortened the list of available documentation versions to only include versions 28.0 and above.
Chores
- Updated site configuration to remove trailing slashes from generated URLs.

These 2 versions are no longer supported

Ensure canonical URLs are generated without trailing slash

coderabbitai · 2025-07-20T09:11:21Z

Walkthrough

This change removes documentation for versions 26.5, 27.0, and 27.1, including guides, options, migration, and introduction files. It also updates Markdown links in introduction files of later versions (28.0, 29.0, 29.2, 29.3, 29.4) to explicitly include the .md extension. The Docusaurus config disables trailing slashes, and the versions list is pruned.

Changes

File(s)	Change Summary
website/versioned_docs/version-26.5/, website/versioned_docs/version-27.0/, website/versioned_docs/version-27.1/*	Deleted all documentation files for versions 26.5, 27.0, and 27.1, including guides, options, migration, and intros.
website/docs/introduction.md, website/versioned_docs/version-28.0/introduction.md, website/versioned_docs/version-29.0/introduction.md, website/versioned_docs/version-29.2/introduction.md, website/versioned_docs/version-29.3/introduction.md, website/versioned_docs/version-29.4/introduction.md	Updated Markdown links from `babel7-or-ts` to `./babel7-or-ts.md` for explicit file extension and path.
website/docusaurus.config.ts	Added `trailingSlash: false` to the Docusaurus config to control URL structure.
website/versions.json	Removed "27.1", "27.0", and "26.5" from the list of documentation versions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    Note over Docs: Before: [babel7-or-ts] links<br>could resolve ambiguously
    User->>Docs: Clicks "Babel7 + preset-typescript vs TypeScript"
    Docs->>Docs: Resolves link to ./babel7-or-ts.md
    Docs-->>User: Loads the correct Markdown file

Possibly related PRs

docs: create doc for v29.4 #4929: Adds new version 29.4 documentation files, including a new babel7-or-ts.md file and related documentation updates; closely related as both PRs involve documentation structure and the babel7-or-ts.md file/linking.

Suggested reviewers

kulshekhar

Poem

Oh, what a hop through docs so wide,
Old guides retired, new links supplied!
Trailing slashes trimmed with care,
Only freshest docs now there.
Markdown links with endings neat,
Make every bunny’s journey sweet.
🥕✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-20T09_30_10_596Z-debug-0.log

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sonarqubecloud · 2025-07-20T09:23:04Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (1)

website/versions.json (1)
1-7: Remove leftover versioned sidebars for pruned releases

We still have sidebar artifacts for 26.5, 27.0, and 27.1 that need to go:

• Delete these files:
– website/versioned_sidebars/version-26.5-sidebars.json
– website/versioned_sidebars/version-27.0-sidebars.json
– website/versioned_sidebars/version-27.1-sidebars.json

• Ensure corresponding docs dirs are removed (if present):
– website/versioned_docs/version-26.5/
– website/versioned_docs/version-27.0/
– website/versioned_docs/version-27.1/

After cleanup, rerun a focused grep to confirm no hard-coded references remain:
rg -n '"(26\.5|27\.0|27\.1)(?:[/"\-_])' website

♻️ Duplicate comments (4)

website/versioned_docs/version-28.0/introduction.md (1)

10-10: Same .md suffix concern applies here

See comment on version 29.0; recommend consistent, extension-less doc links.

website/versioned_docs/version-29.2/introduction.md (1)

10-10: Same .md suffix concern applies here

See comment on version 29.0; recommend consistent, extension-less doc links.

website/versioned_docs/version-29.4/introduction.md (1)

10-10: Same link clarification applied to v29.4 docs

The update mirrors the un-versioned doc and maintains cross-environment consistency. Looks good.

website/versioned_docs/version-29.3/introduction.md (1)

10-10: v29.3 doc link brought in line with other versions

Change is correct and consistent with the rest of the documentation set.

🧹 Nitpick comments (1)

website/versioned_docs/version-29.0/introduction.md (1)
10-10: Link now includes “.md” – validate Docusaurus resolves it

Docusaurus normally prefers doc-ID links ((./babel7-or-ts)).
With trailingSlash: false, adding the .md suffix should still work, but can emit warnings if the file gets renamed.

Consider reverting to the extension-less form to stay future-proof:
-[Read more …](./babel7-or-ts.md)
+[Read more …](./babel7-or-ts)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dbd319b and e5350d0.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (82)

website/docs/introduction.md (1 hunks)
website/docusaurus.config.ts (1 hunks)
website/versioned_docs/version-26.5/babel7-or-ts.md (0 hunks)
website/versioned_docs/version-26.5/contributing.md (0 hunks)
website/versioned_docs/version-26.5/debugging.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/installation.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/astTransformers.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/babelConfig.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/compiler.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/diagnostics.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/isolatedModules.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/stringifyContentPathRegex.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/options/tsconfig.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/paths-mapping.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/presets.md (0 hunks)
website/versioned_docs/version-26.5/getting-started/version-checking.md (0 hunks)
website/versioned_docs/version-26.5/guides/esm-support.md (0 hunks)
website/versioned_docs/version-26.5/guides/mock-es6-class.md (0 hunks)
website/versioned_docs/version-26.5/guides/react-native.md (0 hunks)
website/versioned_docs/version-26.5/guides/test-helpers.md (0 hunks)
website/versioned_docs/version-26.5/guides/troubleshooting.md (0 hunks)
website/versioned_docs/version-26.5/guides/using-with-monorepo.md (0 hunks)
website/versioned_docs/version-26.5/introduction.md (0 hunks)
website/versioned_docs/version-26.5/migration.md (0 hunks)
website/versioned_docs/version-26.5/processing.md (0 hunks)
website/versioned_docs/version-27.0/babel7-or-ts.md (0 hunks)
website/versioned_docs/version-27.0/contributing.md (0 hunks)
website/versioned_docs/version-27.0/debugging.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/installation.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/astTransformers.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/babelConfig.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/compiler.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/diagnostics.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/isolatedModules.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/stringifyContentPathRegex.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/tsconfig.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/options/useESM.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/paths-mapping.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/presets.md (0 hunks)
website/versioned_docs/version-27.0/getting-started/version-checking.md (0 hunks)
website/versioned_docs/version-27.0/guides/esm-support.md (0 hunks)
website/versioned_docs/version-27.0/guides/mock-es6-class.md (0 hunks)
website/versioned_docs/version-27.0/guides/react-native.md (0 hunks)
website/versioned_docs/version-27.0/guides/test-helpers.md (0 hunks)
website/versioned_docs/version-27.0/guides/troubleshooting.md (0 hunks)
website/versioned_docs/version-27.0/guides/using-with-monorepo.md (0 hunks)
website/versioned_docs/version-27.0/introduction.md (0 hunks)
website/versioned_docs/version-27.0/migration.md (0 hunks)
website/versioned_docs/version-27.0/processing.md (0 hunks)
website/versioned_docs/version-27.1/babel7-or-ts.md (0 hunks)
website/versioned_docs/version-27.1/contributing.md (0 hunks)
website/versioned_docs/version-27.1/debugging.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/installation.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/astTransformers.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/babelConfig.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/compiler.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/diagnostics.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/isolatedModules.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/stringifyContentPathRegex.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/tsconfig.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/options/useESM.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/paths-mapping.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/presets.md (0 hunks)
website/versioned_docs/version-27.1/getting-started/version-checking.md (0 hunks)
website/versioned_docs/version-27.1/guides/esm-support.md (0 hunks)
website/versioned_docs/version-27.1/guides/mock-es6-class.md (0 hunks)
website/versioned_docs/version-27.1/guides/react-native.md (0 hunks)
website/versioned_docs/version-27.1/guides/test-helpers.md (0 hunks)
website/versioned_docs/version-27.1/guides/troubleshooting.md (0 hunks)
website/versioned_docs/version-27.1/guides/using-with-monorepo.md (0 hunks)
website/versioned_docs/version-27.1/introduction.md (0 hunks)
website/versioned_docs/version-27.1/migration.md (0 hunks)
website/versioned_docs/version-27.1/processing.md (0 hunks)
website/versioned_docs/version-28.0/introduction.md (1 hunks)
website/versioned_docs/version-29.0/introduction.md (1 hunks)
website/versioned_docs/version-29.2/introduction.md (1 hunks)
website/versioned_docs/version-29.3/introduction.md (1 hunks)
website/versioned_docs/version-29.4/introduction.md (1 hunks)
website/versions.json (1 hunks)

💤 Files with no reviewable changes (74)

website/versioned_docs/version-26.5/guides/esm-support.md
website/versioned_docs/version-26.5/getting-started/version-checking.md
website/versioned_docs/version-26.5/debugging.md
website/versioned_docs/version-27.1/debugging.md
website/versioned_docs/version-27.1/getting-started/options/useESM.md
website/versioned_docs/version-27.0/getting-started/version-checking.md
website/versioned_docs/version-27.0/introduction.md
website/versioned_docs/version-27.0/getting-started/options/useESM.md
website/versioned_docs/version-27.0/guides/using-with-monorepo.md
website/versioned_docs/version-26.5/getting-started/options/compiler.md
website/versioned_docs/version-27.1/getting-started/version-checking.md
website/versioned_docs/version-27.1/introduction.md
website/versioned_docs/version-27.0/migration.md
website/versioned_docs/version-27.0/getting-started/options/compiler.md
website/versioned_docs/version-26.5/introduction.md
website/versioned_docs/version-27.1/getting-started/options/compiler.md
website/versioned_docs/version-26.5/migration.md
website/versioned_docs/version-27.1/migration.md
website/versioned_docs/version-27.0/debugging.md
website/versioned_docs/version-27.1/guides/test-helpers.md
website/versioned_docs/version-26.5/guides/using-with-monorepo.md
website/versioned_docs/version-26.5/guides/test-helpers.md
website/versioned_docs/version-27.1/guides/using-with-monorepo.md
website/versioned_docs/version-27.0/babel7-or-ts.md
website/versioned_docs/version-26.5/guides/mock-es6-class.md
website/versioned_docs/version-26.5/getting-started/installation.md
website/versioned_docs/version-27.0/guides/mock-es6-class.md
website/versioned_docs/version-27.0/getting-started/installation.md
website/versioned_docs/version-26.5/getting-started/options/isolatedModules.md
website/versioned_docs/version-26.5/babel7-or-ts.md
website/versioned_docs/version-27.0/getting-started/options/tsconfig.md
website/versioned_docs/version-27.1/getting-started/paths-mapping.md
website/versioned_docs/version-26.5/getting-started/paths-mapping.md
website/versioned_docs/version-27.1/getting-started/options/babelConfig.md
website/versioned_docs/version-27.0/guides/test-helpers.md
website/versioned_docs/version-27.1/getting-started/installation.md
website/versioned_docs/version-26.5/getting-started/options/tsconfig.md
website/versioned_docs/version-27.1/getting-started/options.md
website/versioned_docs/version-27.1/getting-started/options/astTransformers.md
website/versioned_docs/version-26.5/getting-started/options/stringifyContentPathRegex.md
website/versioned_docs/version-26.5/getting-started/options/babelConfig.md
website/versioned_docs/version-27.1/getting-started/options/isolatedModules.md
website/versioned_docs/version-27.1/getting-started/options/stringifyContentPathRegex.md
website/versioned_docs/version-27.1/guides/react-native.md
website/versioned_docs/version-27.0/getting-started/paths-mapping.md
website/versioned_docs/version-27.0/getting-started/options/isolatedModules.md
website/versioned_docs/version-26.5/getting-started/options.md
website/versioned_docs/version-27.0/getting-started/options/astTransformers.md
website/versioned_docs/version-26.5/guides/react-native.md
website/versioned_docs/version-27.0/getting-started/options/stringifyContentPathRegex.md
website/versioned_docs/version-26.5/processing.md
website/versioned_docs/version-26.5/getting-started/options/astTransformers.md
website/versioned_docs/version-27.1/guides/troubleshooting.md
website/versioned_docs/version-27.1/getting-started/options/tsconfig.md
website/versioned_docs/version-27.0/getting-started/options/babelConfig.md
website/versioned_docs/version-27.1/babel7-or-ts.md
website/versioned_docs/version-27.0/processing.md
website/versioned_docs/version-26.5/getting-started/options/diagnostics.md
website/versioned_docs/version-26.5/getting-started/presets.md
website/versioned_docs/version-27.1/getting-started/options/diagnostics.md
website/versioned_docs/version-27.1/guides/mock-es6-class.md
website/versioned_docs/version-27.1/contributing.md
website/versioned_docs/version-26.5/contributing.md
website/versioned_docs/version-27.1/guides/esm-support.md
website/versioned_docs/version-27.0/getting-started/options.md
website/versioned_docs/version-26.5/guides/troubleshooting.md
website/versioned_docs/version-27.0/contributing.md
website/versioned_docs/version-27.1/getting-started/presets.md
website/versioned_docs/version-27.0/guides/react-native.md
website/versioned_docs/version-27.0/guides/troubleshooting.md
website/versioned_docs/version-27.0/getting-started/presets.md
website/versioned_docs/version-27.0/getting-started/options/diagnostics.md
website/versioned_docs/version-27.0/guides/esm-support.md
website/versioned_docs/version-27.1/processing.md

🧰 Additional context used

🪛 LanguageTool

website/versioned_docs/version-29.3/introduction.md