diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67769303a3..381eac5cb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,14 +94,4 @@ The `test` script uses Vitest to run unit testings. ## Documentation -VuePress documentation is powered by VuePress itself, which is built from the source code of this repository. - -All the markdown source files are placed in `docs` directory. We are maintaining two translations: - -- English (en-US) in `/` path -- Chinese (zh-CN) in `/zh/` path - -We have two different deployments: - -- Release deployment powered by [Netlify](https://www.netlify.com). This deployment is built from the latest released version, so users will not see unreleased changes. The domain name is [https://v2.vuepress.vuejs.org](https://v2.vuepress.vuejs.org). -- Developer deployment powered by [GitHub Pages](https://pages.github.com). This deployment is built from the latest commit, so developers could preview the latest changes. The domain name is [https://vuepress.github.io](https://vuepress.github.io). +VuePress documentation is maintained in [vuepress/docs](https://github.com/vuepress/docs) repository. diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md index e710045bab..407e8f7b43 100644 --- a/CONTRIBUTING_zh.md +++ b/CONTRIBUTING_zh.md @@ -94,14 +94,4 @@ VuePress 使用它自己来构建自己的文档网站。 ## 文档 -VuePress 的文档是由 VuePress 自己驱动的,是由该仓库中的源码构建而来。 - -所有的 Markdown 源文件都放置在 `docs` 目录下。我们维护了两种翻译: - -- 英语 (en-US) 在 `/` 路径下 -- 中文 (zh-CN) 在 `/zh/` 路径下 - -我们部署了两套站点: - -- 在 [Netlify](https://www.netlify.com) 部署的 Release 版本。该站点是从最新发布的版本中构建而来,因此用户不会看到未发布的改动。域名为 [https://v2.vuepress.vuejs.org](https://v2.vuepress.vuejs.org)。 -- 在 [GitHub Pages](https://pages.github.com) 部署的 Developer 版本。该站点是从最新的提交中构建而来,因此开发者可以预览最新的改动。域名为 [https://vuepress.github.io](https://vuepress.github.io)。 +VuePress 的文档在 [vuepress/docs](https://github.com/vuepress/docs) 仓库中进行维护。 diff --git a/README.md b/README.md index d4f8461040..2c6879d7ce 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # vuepress-next -[![github check](https://github.com/vuepress/vuepress-next/workflows/check/badge.svg)](https://github.com/vuepress/vuepress-next/actions?query=workflow%3Acheck) -[![github docs](https://github.com/vuepress/vuepress-next/workflows/docs/badge.svg)](https://github.com/vuepress/vuepress-next/actions?query=workflow%3Adocs) +[![check](https://github.com/vuepress/vuepress-next/workflows/check/badge.svg)](https://github.com/vuepress/vuepress-next/actions/workflows/check.yml?query=workflow%3Acheck) [![npm](https://badgen.net/npm/v/vuepress/next)](https://www.npmjs.com/package/vuepress) [![coverage](https://coveralls.io/repos/github/vuepress/vuepress-next/badge.svg?branch=main)](https://coveralls.io/github/vuepress/vuepress-next?branch=main) [![license](https://badgen.net/github/license/vuepress/vuepress-next)](https://github.com/vuepress/vuepress-next/blob/main/LICENSE) @@ -17,7 +16,9 @@ https://v2.vuepress.vuejs.org ## Contribution -See [Contributing Guide](https://github.com/vuepress/vuepress-next/blob/main/docs/contributing.md). +See [Contributing Guide](https://github.com/vuepress/vuepress-next/blob/main/CONTRIBUTING.md) + +查看 [贡献指南](https://github.com/vuepress/vuepress-next/blob/main/CONTRIBUTING_zh.md) ## License