From db1b3c2cfb44862c97125308dcafd5622affebcd Mon Sep 17 00:00:00 2001 From: neverland Date: Sun, 28 Apr 2024 11:04:50 +0800 Subject: [PATCH] docs: sort about docs to make them more clear (#6378) * docs: sort about docs to make them more clear * docs: update * docs: fix links * docs: fix links --- website/docs/en/config/cache.mdx | 2 +- website/docs/en/misc/_meta.json | 22 +++++++++++++------ website/docs/en/misc/branding/_meta.json | 1 + .../{branding.mdx => branding/guideline.mdx} | 0 website/docs/en/misc/branding/license.mdx | 9 ++++++++ website/docs/en/misc/license.md | 5 ----- website/docs/en/misc/planning/_meta.json | 1 + .../docs/en/misc/{ => planning}/future.mdx | 4 +++- .../misc/{roadmap.md => planning/roadmap.mdx} | 0 website/docs/en/misc/team/_meta.json | 1 + .../en/misc/{team.mdx => team/core-team.mdx} | 6 ++--- .../{acknowledgments.mdx => team/emeriti.mdx} | 4 +--- website/docs/en/misc/{ => team}/join-us.mdx | 0 website/docs/zh/config/cache.mdx | 2 +- website/docs/zh/misc/_meta.json | 22 +++++++++++++------ website/docs/zh/misc/branding/_meta.json | 1 + .../{branding.mdx => branding/guideline.mdx} | 0 website/docs/zh/misc/branding/license.mdx | 9 ++++++++ website/docs/zh/misc/faq.mdx | 2 +- website/docs/zh/misc/license.mdx | 5 ----- website/docs/zh/misc/planning/_meta.json | 1 + .../docs/zh/misc/{ => planning}/future.mdx | 12 +++++----- .../docs/zh/misc/{ => planning}/roadmap.mdx | 0 website/docs/zh/misc/team/_meta.json | 1 + .../zh/misc/{team.mdx => team/core-team.mdx} | 4 ++-- .../{acknowledgments.mdx => team/emeriti.mdx} | 4 +--- website/docs/zh/misc/{ => team}/join-us.mdx | 0 27 files changed, 74 insertions(+), 44 deletions(-) create mode 100644 website/docs/en/misc/branding/_meta.json rename website/docs/en/misc/{branding.mdx => branding/guideline.mdx} (100%) create mode 100644 website/docs/en/misc/branding/license.mdx delete mode 100644 website/docs/en/misc/license.md create mode 100644 website/docs/en/misc/planning/_meta.json rename website/docs/en/misc/{ => planning}/future.mdx (80%) rename website/docs/en/misc/{roadmap.md => planning/roadmap.mdx} (100%) create mode 100644 website/docs/en/misc/team/_meta.json rename website/docs/en/misc/{team.mdx => team/core-team.mdx} (88%) rename website/docs/en/misc/{acknowledgments.mdx => team/emeriti.mdx} (86%) rename website/docs/en/misc/{ => team}/join-us.mdx (100%) create mode 100644 website/docs/zh/misc/branding/_meta.json rename website/docs/zh/misc/{branding.mdx => branding/guideline.mdx} (100%) create mode 100644 website/docs/zh/misc/branding/license.mdx delete mode 100644 website/docs/zh/misc/license.mdx create mode 100644 website/docs/zh/misc/planning/_meta.json rename website/docs/zh/misc/{ => planning}/future.mdx (62%) rename website/docs/zh/misc/{ => planning}/roadmap.mdx (100%) create mode 100644 website/docs/zh/misc/team/_meta.json rename website/docs/zh/misc/{team.mdx => team/core-team.mdx} (61%) rename website/docs/zh/misc/{acknowledgments.mdx => team/emeriti.mdx} (87%) rename website/docs/zh/misc/{ => team}/join-us.mdx (100%) diff --git a/website/docs/en/config/cache.mdx b/website/docs/en/config/cache.mdx index 721228cbcbf..200ca472671 100644 --- a/website/docs/en/config/cache.mdx +++ b/website/docs/en/config/cache.mdx @@ -15,7 +15,7 @@ At this stage, Rspack will cache the results of module build and generate snapsh At this stage, Rspack will cache the final code generated by the module, and if the module has not changed, it will directly reuse the generated code when rebuilding. :::info Cache Type -Rspack currently only supports memory cache, persistent cache is under planning, for more details refer to [persistent-cache-support](misc/roadmap#persistent-cache-support). +Rspack currently only supports memory cache, persistent cache is under planning, for more details refer to [persistent-cache-support](/misc/planning/roadmap#persistent-cache-support). ::: This configuration currently only supports setting whether to enable caching. diff --git a/website/docs/en/misc/_meta.json b/website/docs/en/misc/_meta.json index 5e7c9f854b0..71206e41e0d 100644 --- a/website/docs/en/misc/_meta.json +++ b/website/docs/en/misc/_meta.json @@ -1,12 +1,20 @@ [ "faq", - "roadmap", "glossary", - "future", - "team", - "acknowledgments", - "join-us", "benchmark", - "branding", - "license" + { + "type": "dir", + "name": "planning", + "label": "Planning" + }, + { + "type": "dir", + "name": "team", + "label": "Team" + }, + { + "type": "dir", + "name": "branding", + "label": "Branding" + } ] diff --git a/website/docs/en/misc/branding/_meta.json b/website/docs/en/misc/branding/_meta.json new file mode 100644 index 00000000000..4b453c4dd67 --- /dev/null +++ b/website/docs/en/misc/branding/_meta.json @@ -0,0 +1 @@ +["guideline", "license"] diff --git a/website/docs/en/misc/branding.mdx b/website/docs/en/misc/branding/guideline.mdx similarity index 100% rename from website/docs/en/misc/branding.mdx rename to website/docs/en/misc/branding/guideline.mdx diff --git a/website/docs/en/misc/branding/license.mdx b/website/docs/en/misc/branding/license.mdx new file mode 100644 index 00000000000..a6ea644e43d --- /dev/null +++ b/website/docs/en/misc/branding/license.mdx @@ -0,0 +1,9 @@ +# License + +## Rspack + +Rspack is [MIT licensed](https://github.com/web-infra-dev/rspack/blob/main/LICENSE). + +## Rspack documentation + +Unless otherwise noted, the content of the documents is from [Rspack website contributors](https://github.com/web-infra-dev/rspack/graphs/contributors) and is licensed under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en) license. diff --git a/website/docs/en/misc/license.md b/website/docs/en/misc/license.md deleted file mode 100644 index 49648397ce1..00000000000 --- a/website/docs/en/misc/license.md +++ /dev/null @@ -1,5 +0,0 @@ -# License - -## Rspack documentation - -Unless otherwise noted, the content of the documents is from [Rspack website contributors](https://github.com/web-infra-dev/rspack/network/contributors) and is licensed under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en) license. diff --git a/website/docs/en/misc/planning/_meta.json b/website/docs/en/misc/planning/_meta.json new file mode 100644 index 00000000000..a1e6ecd6d74 --- /dev/null +++ b/website/docs/en/misc/planning/_meta.json @@ -0,0 +1 @@ +["roadmap", "future"] diff --git a/website/docs/en/misc/future.mdx b/website/docs/en/misc/planning/future.mdx similarity index 80% rename from website/docs/en/misc/future.mdx rename to website/docs/en/misc/planning/future.mdx index ea2f9085204..969c2fd43b0 100644 --- a/website/docs/en/misc/future.mdx +++ b/website/docs/en/misc/planning/future.mdx @@ -4,7 +4,9 @@ import { DeprecationTable } from '@components/DeprecationTable'; ## Breaking Changes -During the 0.y.z phase, Rspack may include breaking changes only when upgrading the minor (y) version, and ensures backward compatibility when upgrading the patch (z) version. After reaching version 1.0.0, we will adhere to [semver](https://semver.org/) for version management. +During the 0.y.z phase, Rspack may include breaking changes only when upgrading the minor (y) version, and ensures backward compatibility when upgrading the patch (z) version. + +After reaching version 1.0.0, we will adhere to [semver](https://semver.org/) for version management. ## Future Default Behavior (Rspack Future) diff --git a/website/docs/en/misc/roadmap.md b/website/docs/en/misc/planning/roadmap.mdx similarity index 100% rename from website/docs/en/misc/roadmap.md rename to website/docs/en/misc/planning/roadmap.mdx diff --git a/website/docs/en/misc/team/_meta.json b/website/docs/en/misc/team/_meta.json new file mode 100644 index 00000000000..2cd2e82d9cc --- /dev/null +++ b/website/docs/en/misc/team/_meta.json @@ -0,0 +1 @@ +["core-team", "emeriti", "join-us"] diff --git a/website/docs/en/misc/team.mdx b/website/docs/en/misc/team/core-team.mdx similarity index 88% rename from website/docs/en/misc/team.mdx rename to website/docs/en/misc/team/core-team.mdx index 2952070e004..ed55de54b7b 100644 --- a/website/docs/en/misc/team.mdx +++ b/website/docs/en/misc/team/core-team.mdx @@ -1,15 +1,15 @@ import { RandomMemberList } from '@components/RandomMemberList.tsx'; -# Meet the team +# Core team The development of Rspack is led by a dedicated team who work full-time at ByteDance. Additionally, contributions are received from people all over the world. Current members of the Rspack team are listed in random order below. -## Rspack Core +## Members ## Past Contributors -You can find the past team members and other people who significantly contributed to Rspack over the years on the [acknowledgments](/misc/acknowledgments) page. +You can find the past team members and other people who significantly contributed to Rspack over the years on the [acknowledgments](//misc/team/emeriti) page. diff --git a/website/docs/en/misc/acknowledgments.mdx b/website/docs/en/misc/team/emeriti.mdx similarity index 86% rename from website/docs/en/misc/acknowledgments.mdx rename to website/docs/en/misc/team/emeriti.mdx index 2f1ba554d36..6152f8981d4 100644 --- a/website/docs/en/misc/acknowledgments.mdx +++ b/website/docs/en/misc/team/emeriti.mdx @@ -1,8 +1,6 @@ import { RandomContributorsList } from '@components/RandomMemberList.tsx'; -# Acknowledgments - -## Past Contributors +# Emeriti members We'd like to recognize a few people who have made significant contributions to Rspack and its ecosystem in the past and have helped maintain them over the years. diff --git a/website/docs/en/misc/join-us.mdx b/website/docs/en/misc/team/join-us.mdx similarity index 100% rename from website/docs/en/misc/join-us.mdx rename to website/docs/en/misc/team/join-us.mdx diff --git a/website/docs/zh/config/cache.mdx b/website/docs/zh/config/cache.mdx index b57f97d46fc..e2cecf1f2dd 100644 --- a/website/docs/zh/config/cache.mdx +++ b/website/docs/zh/config/cache.mdx @@ -15,7 +15,7 @@ 在此阶段 Rspack 会缓存模块最终生成的代码，在重新构建时若模块没有改动则直接复用结果代码。 :::info 缓存类型 -rspack 当前仅支持内存缓存（Memory Cache），持久化缓存（Persistent Cache）正在规划中，更多细节参考 [Persistent Cache 支持](misc/roadmap#persistent-cache-支持)。 +rspack 当前仅支持内存缓存（Memory Cache），持久化缓存（Persistent Cache）正在规划中，更多细节参考 [Persistent Cache 支持](/misc/planning/roadmap#persistent-cache-支持)。 ::: 此配置当前仅支持控制是否进行缓存。 diff --git a/website/docs/zh/misc/_meta.json b/website/docs/zh/misc/_meta.json index 5e7c9f854b0..18513bc0f22 100644 --- a/website/docs/zh/misc/_meta.json +++ b/website/docs/zh/misc/_meta.json @@ -1,12 +1,20 @@ [ "faq", - "roadmap", "glossary", - "future", - "team", - "acknowledgments", - "join-us", "benchmark", - "branding", - "license" + { + "type": "dir", + "name": "planning", + "label": "规划" + }, + { + "type": "dir", + "name": "team", + "label": "团队" + }, + { + "type": "dir", + "name": "branding", + "label": "品牌" + } ] diff --git a/website/docs/zh/misc/branding/_meta.json b/website/docs/zh/misc/branding/_meta.json new file mode 100644 index 00000000000..4b453c4dd67 --- /dev/null +++ b/website/docs/zh/misc/branding/_meta.json @@ -0,0 +1 @@ +["guideline", "license"] diff --git a/website/docs/zh/misc/branding.mdx b/website/docs/zh/misc/branding/guideline.mdx similarity index 100% rename from website/docs/zh/misc/branding.mdx rename to website/docs/zh/misc/branding/guideline.mdx diff --git a/website/docs/zh/misc/branding/license.mdx b/website/docs/zh/misc/branding/license.mdx new file mode 100644 index 00000000000..474d63bdfb4 --- /dev/null +++ b/website/docs/zh/misc/branding/license.mdx @@ -0,0 +1,9 @@ +# 版权声明 + +## Rspack + +Rspack 基于 [MIT 协议](https://github.com/web-infra-dev/rspack/blob/main/LICENSE). + +## Rspack 文档 + +除非另有说明，本站文档内容源自 [Rspack website 贡献者](https://github.com/web-infra-dev/rspack/graphs/contributors)，遵循 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.zh) 许可协议。 diff --git a/website/docs/zh/misc/faq.mdx b/website/docs/zh/misc/faq.mdx index 84038534ddc..a44612cb6f5 100644 --- a/website/docs/zh/misc/faq.mdx +++ b/website/docs/zh/misc/faq.mdx @@ -1,4 +1,4 @@ -# FAQ +# 常见问题 ## 未来 Rspack 和 Webpack 的关系是怎样的 diff --git a/website/docs/zh/misc/license.mdx b/website/docs/zh/misc/license.mdx deleted file mode 100644 index 2b67e2822cb..00000000000 --- a/website/docs/zh/misc/license.mdx +++ /dev/null @@ -1,5 +0,0 @@ -# 版权声明 - -## Rspack 文档 - -除非另有说明，本站文档内容源自 [Rspack website 贡献者](https://github.com/web-infra-dev/rspack/network/contributors)，遵循 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.zh) 许可协议。 diff --git a/website/docs/zh/misc/planning/_meta.json b/website/docs/zh/misc/planning/_meta.json new file mode 100644 index 00000000000..a1e6ecd6d74 --- /dev/null +++ b/website/docs/zh/misc/planning/_meta.json @@ -0,0 +1 @@ +["roadmap", "future"] diff --git a/website/docs/zh/misc/future.mdx b/website/docs/zh/misc/planning/future.mdx similarity index 62% rename from website/docs/zh/misc/future.mdx rename to website/docs/zh/misc/planning/future.mdx index 8d307e2f6f8..bba2132796a 100644 --- a/website/docs/zh/misc/future.mdx +++ b/website/docs/zh/misc/planning/future.mdx @@ -1,15 +1,17 @@ import { DeprecationTable } from '@components/DeprecationTable'; -# 未来默认行为与功能废弃 +# 功能演进与废弃 -## 破坏性更新(Breaking Changes) +## 破坏性更新（breaking changes) -Rspack 在 0.y.z 的阶段仅可能会在 minor（y）版本升级的时候包含破坏性更新，在 patch（z） 版本升级时则保证功能的向下兼容性。在达到 1.0.0 版本后，我们将会遵循 [semver](https://semver.org/) 进行版本管理。 +Rspack 在 0.y.z 的阶段仅可能会在 minor（y）版本升级的时候包含破坏性更新，在 patch（z） 版本升级时则保证功能的向下兼容性。 -## 未来默认行为(Rspack Future) +在达到 1.0.0 版本后，我们将会遵循 [semver](https://semver.org/) 进行版本管理。 + +## 未来默认行为 (Rspack future) Rspack 在 [experiments.rspackFuture](/config/experiments#experimentsrspackfuture) 中提供了一些实验性的功能，这些功能在未来会成为默认行为，但是目前还不是默认行为，需要在配置文件中显式开启。 -## 功能废弃(Deprecation) +## 功能废弃 (deprecation) diff --git a/website/docs/zh/misc/roadmap.mdx b/website/docs/zh/misc/planning/roadmap.mdx similarity index 100% rename from website/docs/zh/misc/roadmap.mdx rename to website/docs/zh/misc/planning/roadmap.mdx diff --git a/website/docs/zh/misc/team/_meta.json b/website/docs/zh/misc/team/_meta.json new file mode 100644 index 00000000000..2cd2e82d9cc --- /dev/null +++ b/website/docs/zh/misc/team/_meta.json @@ -0,0 +1 @@ +["core-team", "emeriti", "join-us"] diff --git a/website/docs/zh/misc/team.mdx b/website/docs/zh/misc/team/core-team.mdx similarity index 61% rename from website/docs/zh/misc/team.mdx rename to website/docs/zh/misc/team/core-team.mdx index fb8da70ebaf..49ac86185b6 100644 --- a/website/docs/zh/misc/team.mdx +++ b/website/docs/zh/misc/team/core-team.mdx @@ -1,6 +1,6 @@ import { RandomMemberList } from '@components/RandomMemberList.tsx'; -# 团队 +# 核心团队 Rspack 的开发是由 ByteDance 的 Rspack 团队和社区贡献者驱动。 @@ -12,4 +12,4 @@ Rspack 的开发是由 ByteDance 的 Rspack 团队和社区贡献者驱动。 ## 过去的贡献者 -你可以访问我们的 [致谢](/misc/acknowledgments) 页面，查看那些曾在过去为 Rspack 付出过重要贡献的团队成员和其他人士。 +你可以访问我们的 [致谢](//misc/team/emeriti) 页面，查看那些曾在过去为 Rspack 付出过重要贡献的团队成员和其他人士。 diff --git a/website/docs/zh/misc/acknowledgments.mdx b/website/docs/zh/misc/team/emeriti.mdx similarity index 87% rename from website/docs/zh/misc/acknowledgments.mdx rename to website/docs/zh/misc/team/emeriti.mdx index 00eac47a7f7..8a95c7d315b 100644 --- a/website/docs/zh/misc/acknowledgments.mdx +++ b/website/docs/zh/misc/team/emeriti.mdx @@ -1,8 +1,6 @@ import { RandomContributorsList } from '@components/RandomMemberList.tsx'; -# 致谢 - -## Past Contributors +# 荣誉成员 我们希望感谢过去对 Rspack 及其生态系统做出重大贡献并多年来帮助维护它们的一些人。 diff --git a/website/docs/zh/misc/join-us.mdx b/website/docs/zh/misc/team/join-us.mdx similarity index 100% rename from website/docs/zh/misc/join-us.mdx rename to website/docs/zh/misc/team/join-us.mdx