Skip to content

Conversation

@chenjiahan
Copy link
Member

Summary

Update the links to use relative paths. This will ensure that the dead link checker in Rspress works as expected.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings May 27, 2025 14:13
@netlify
Copy link

netlify bot commented May 27, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 9bfd838
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/6835c89bf81afc00085b5c53
😎 Deploy Preview https://deploy-preview-5320--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 57 (🔴 down 27 from production)
Accessibility: 97 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation links from absolute URLs to relative paths across Chinese and English guides to ensure compatibility with the Rspress dead link checker.

  • Replace absolute links (https://rsbuild.dev/…) with relative paths in /api, /plugins, and /guide sections.
  • Adjust cache docs to point to the correct English Rspack config URL.
  • Update community release notes in both Chinese and English to use relative links.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/docs/zh/community/releases/v1-0.mdx Updated several absolute links to relative; note list formatting changes.
website/docs/zh/community/releases/v0-5.mdx Switched createDevServer link to relative.
website/docs/en/plugins/dev/core.mdx Changed environment plugin link to relative.
website/docs/en/config/performance/build-cache.mdx Updated Rspack cache link to English relative.
website/docs/en/community/releases/v1-0.mdx Converted absolute links to relative; check list styling.
Comments suppressed due to low confidence (11)

website/docs/zh/community/releases/v1-0.mdx:57

  • [nitpick] The leading > now renders a markdown blockquote instead of a literal arrow (->). If the original arrow was intentional, consider restoring it or using a consistent notation.
> 参考 [Rsbuild 介绍](/zh/guide/start/index) 了解 Rsbuild 与 webpack、Vue CLI、Vite 的对比。

website/docs/zh/community/releases/v1-0.mdx:83

  • This line uses a single hyphen but was originally nested (--). Verify that the list indentation and nesting level remain correct after the change.
- 如果你还未使用过 Rsbuild,可以通过 [CodeSandbox 示例](https://codesandbox.io/p/github/rspack-contrib/rsbuild-codesandbox-example) 来体验,也可以参考 [快速上手](/zh/guide/start/quick-start) 来接入 Rsbuild。

website/docs/zh/community/releases/v1-0.mdx:84

  • The single hyphen here changes the original nested list level. Confirm that this bullet remains under the intended parent list.
- 如果你正在使用 Rsbuild 0.7 或更早的版本,请留意 1.0 版本包含一些不兼容更新,可参考 [从 Rsbuild 0.x 迁移](/zh/guide/migration/rsbuild-0-x) 文档进行升级。

website/docs/zh/community/releases/v1-0.mdx:85

  • Ensure this single hyphen list item maintains the correct nesting, as it was originally indented with double hyphens.
- Rsbuild 也提供了 webpack、CRA、Vue CLI 等项目的迁移指南,详见 [从现有项目迁移](/zh/guide/start/quick-start#%E4%BB%8E%E7%8E%B0%E6%9C%89%E9%A1%B9%E7%9B%AE%E8%BF%81%E7%A7%BB)。

website/docs/zh/community/releases/v1-0.mdx:91

  • This line no longer starts with a hyphen, so it may no longer be part of the intended list. Please confirm its formatting.
Rsbuild 1.0 为企业级应用和上层工具开发提供了一些高级特性,例如 [多环境构建 API](/zh/guide/advanced/environments)、[服务端渲染 API](/zh/guide/advanced/ssr)、[插件 API](/plugins/dev/)、[模块联邦支持](/zh/guide/advanced/module-federation) 和 [Library 构建(Rslib)](https://github.com/web-infra-dev/rslib),我们计划继续完善这些特性,更好地支持 Rsbuild 生态发展。

website/docs/en/community/releases/v1-0.mdx:40

  • This bullet was originally nested (prefixed with --). Confirm that the list indentation is still correct with a single hyphen.
- As a shared infrastructure: Provides [JavaScript API](/api/start/) and [Plugin API](/plugins/dev/) for higher-level tools and frameworks, allowing developers to easily build their tools or frameworks on top of Rsbuild.

website/docs/en/community/releases/v1-0.mdx:57

  • [nitpick] Replacing -> with > changes from a literal arrow to a blockquote. If the arrow was intentional, consider restoring it or unifying on a single style.
> See the [Rsbuild Introduction](/guide/start/index) for more comparisons between Rsbuild, webpack, Vue CLI, and Vite.

website/docs/en/community/releases/v1-0.mdx:83

  • This bullet was originally indented as a nested list (--). Verify the list nesting level to keep the structure consistent.
- If you haven't used Rsbuild before, you can experience it through the [CodeSandbox example](https://codesandbox.io/p/github/rspack-contrib/rsbuild-codesandbox-example) or refer to the [Quick start](/guide/start/quick-start) to use Rsbuild.

website/docs/en/community/releases/v1-0.mdx:84

  • Confirm this bullet retains its nested level, since it was originally using -- for indentation.
- If you are using Rsbuild 0.7 or earlier, please note that 1.0 includes some breaking changes. You can refer to the [Migrating from 0.x](/guide/migration/rsbuild-0-x) document to upgrade.

website/docs/en/community/releases/v1-0.mdx:85

  • This list item was originally nested deeper; please check that the single hyphen preserves the intended hierarchy.
- Rsbuild also provides migration guides for projects that use webpack, CRA, Vue CLI, etc. See [Migrate from Existing Projects](/guide/start/quick-start#migrate-from-existing-projects).

website/docs/en/community/releases/v1-0.mdx:91

  • This line no longer starts with a list marker; it may have been intended as part of the previous bulleted list. Please verify formatting.
Rsbuild 1.0 provides several advanced features for the development of enterprise applications and higher-level tools, such as the [multi-environment build API](/guide/advanced/environments), [SSR API](/guide/advanced/ssr), [plugin API](/plugins/dev/), [Module Federation support](/guide/advanced/module-federation), and [library build (Rslib)](https://github.com/web-infra-dev/rslib). We plan to continue to enhance these features to better support the development of the Rsbuild ecosystem.

@chenjiahan chenjiahan merged commit 3045bd0 into main May 27, 2025
12 checks passed
@chenjiahan chenjiahan deleted the docs_relative_paths_0527 branch May 27, 2025 14:18
@chenjiahan chenjiahan mentioned this pull request Jun 2, 2025
@chenjiahan chenjiahan mentioned this pull request Jun 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant