Skip to content

Commit b72b7dd

Browse files
authored
[Docs] Update Readme, Contributing, etc. (PaddlePaddle#5108)
* Update CONTRIBUTING.md * Update README_cn.md * Update CONTRIBUTING_cn.md * Update CONTRIBUTING_cn.md * Update README.md * Update release_note_en.md * Update release_note_cn.md * Update release_note_cn.md * Update release doc. * Fix typos.
1 parent 38f3abf commit b72b7dd

6 files changed

+470
-470
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ PaddlePaddle's API documentation contains an introduction to the API. We welcome
2626

2727
### Guides
2828

29-
This part of the content is stored in the [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) directory, you can make your changes by submitting a PR. For more information, please refer to: [Document Contribution Guide](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97) .
29+
This part of the content is stored in the [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) directory, you can make your changes by submitting a PR. For more information, please refer to: [Document Contribution Guide](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97).
3030

3131
### Practice
3232

@@ -38,4 +38,4 @@ PaddlePaddle provides API documentation in both Chinese and English. The English
3838

3939
## Submit PR
4040

41-
Any modification of PaddlePaddle documentation should be completed by submitting a PR. For more information, please refer to [Submit PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
41+
Any modification of PaddlePaddle documentation should be completed by submitting a PR. For more information, please refer to [Submit PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html).

CONTRIBUTING_cn.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ API 文档是飞桨框架的 API 文档,包含了飞桨框架 API 的说明介
3030

3131
### 应用实践
3232

33-
这部分内容分为源代码与官网文档两部分,源代码的部分以 notebook 的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的 notebook 格式的源码于该目录中;在你的 notebook 文件被合入后,我们会将其转为 md 文件,存储在[docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial)中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905).
33+
这部分内容分为源代码与官网文档两部分,源代码的部分以 notebook 的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的 notebook 格式的源码于该目录中;在你的 notebook 文件被合入后,我们会将其转为 md 文件,存储在 [docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial) 中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905)
3434

3535
### API 文档
3636

37-
飞桨框架同时提供中英文 API 文档。其中,英文 API 文档存于[Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle)源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文 API 文档存放在[docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api)目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于 API 文档所付出的一切。具体修改方式请参考:[英文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)[中文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
37+
飞桨框架同时提供中英文 API 文档。其中,英文 API 文档存于 [Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle) 源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文 API 文档存放在 [docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api) 目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于 API 文档所付出的一切。具体修改方式请参考:[英文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)[中文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
3838

3939
## 提交 PR
4040

41-
你对于飞桨文档的任何修改,都应该通过提交 PR 的方式来完成,具体的方法可以参考[提交 PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
41+
你对于飞桨文档的任何修改,都应该通过提交 PR 的方式来完成,具体的方法可以参考[提交 PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Note: English version API docs are generaly docstrings in [PaddlePaddle/Paddle](
99

1010
## Codebase structure
1111

12-
- [docs](docs): PaddlePaddle 2.0 & above docs source file,
13-
- [docs/api](docs/api): PaddlePaddle API docs
14-
- [docs/guides](docs/guides): PaddlePaddle guides docs
15-
- [docs/tutorial](docs/tutorial): PaddlePaddle tutorial docs
16-
- [ci_scripts](ci_scripts): docs CI scripts
12+
- [docs](docs): PaddlePaddle 2.0 & above docs source file.
13+
- [docs/api](docs/api): PaddlePaddle API docs.
14+
- [docs/guides](docs/guides): PaddlePaddle guides docs.
15+
- [docs/tutorial](docs/tutorial): PaddlePaddle tutorial docs.
16+
- [ci_scripts](ci_scripts): docs CI scripts.
1717

1818
## How to build
1919

README_cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ docs 是 [PaddlePaddle 官网文档](https://www.paddlepaddle.org.cn/documentati
3030
bash docs-build.sh -f absolute_path_docs
3131
```
3232
- step3: preview docs
33-
输出的文件会保存在 docs/output 路径下.
33+
输出的文件会保存在 docs/output 路径下
3434
3535
## 贡献
3636

0 commit comments

Comments
 (0)