Skip to content

Commit

Permalink
docs: sort about docs to make them more clear (#6378)
Browse files Browse the repository at this point in the history
* docs: sort about docs to make them more clear

* docs: update

* docs: fix links

* docs: fix links
  • Loading branch information
chenjiahan authored Apr 28, 2024
1 parent e4fdc75 commit db1b3c2
Show file tree
Hide file tree
Showing 27 changed files with 74 additions and 44 deletions.
2 changes: 1 addition & 1 deletion website/docs/en/config/cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
22 changes: 15 additions & 7 deletions website/docs/en/misc/_meta.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
1 change: 1 addition & 0 deletions website/docs/en/misc/branding/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["guideline", "license"]
File renamed without changes.
9 changes: 9 additions & 0 deletions website/docs/en/misc/branding/license.mdx
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 0 additions & 5 deletions website/docs/en/misc/license.md

This file was deleted.

1 change: 1 addition & 0 deletions website/docs/en/misc/planning/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["roadmap", "future"]
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions website/docs/en/misc/team/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["core-team", "emeriti", "join-us"]
Original file line number Diff line number Diff line change
@@ -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

<RandomMemberList />

## 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.
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion website/docs/zh/config/cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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-支持)
:::

此配置当前仅支持控制是否进行缓存。
Expand Down
22 changes: 15 additions & 7 deletions website/docs/zh/misc/_meta.json
Original file line number Diff line number Diff line change
@@ -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": "品牌"
}
]
1 change: 1 addition & 0 deletions website/docs/zh/misc/branding/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["guideline", "license"]
File renamed without changes.
9 changes: 9 additions & 0 deletions website/docs/zh/misc/branding/license.mdx
Original file line number Diff line number Diff line change
@@ -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) 许可协议。
2 changes: 1 addition & 1 deletion website/docs/zh/misc/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FAQ
# 常见问题

## 未来 Rspack 和 Webpack 的关系是怎样的

Expand Down
5 changes: 0 additions & 5 deletions website/docs/zh/misc/license.mdx

This file was deleted.

1 change: 1 addition & 0 deletions website/docs/zh/misc/planning/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["roadmap", "future"]
Original file line number Diff line number Diff line change
@@ -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)

<DeprecationTable />
File renamed without changes.
1 change: 1 addition & 0 deletions website/docs/zh/misc/team/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["core-team", "emeriti", "join-us"]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { RandomMemberList } from '@components/RandomMemberList.tsx';

# 团队
# 核心团队

Rspack 的开发是由 ByteDance 的 Rspack 团队和社区贡献者驱动。

Expand All @@ -12,4 +12,4 @@ Rspack 的开发是由 ByteDance 的 Rspack 团队和社区贡献者驱动。

## 过去的贡献者

你可以访问我们的 [致谢](/misc/acknowledgments) 页面,查看那些曾在过去为 Rspack 付出过重要贡献的团队成员和其他人士。
你可以访问我们的 [致谢](//misc/team/emeriti) 页面,查看那些曾在过去为 Rspack 付出过重要贡献的团队成员和其他人士。
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import { RandomContributorsList } from '@components/RandomMemberList.tsx';

# 致谢

## Past Contributors
# 荣誉成员

我们希望感谢过去对 Rspack 及其生态系统做出重大贡献并多年来帮助维护它们的一些人。

Expand Down
File renamed without changes.

0 comments on commit db1b3c2

Please sign in to comment.