PaddlePaddle / PaddlePaddle/docs
[Feature Request] 为飞桨API文档增加 inplace 介绍&链接
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 284
- Forks
- 906
- PR merge metrics
- No merged PRs in 30d
Description
为了提升 inplace 相关API文档的使用体验与易读性，我们希望借助社区的力量，补全文档内容：
1、在这个文件中，将 Inplace 版本的API，单独作为一类列举，并添加 inplace 概念的介绍： https://github.com/PaddlePaddle/docs/blob/develop/docs/api/paddle/Overview_cn.rst
2、为每个 Inplace 版本的中英文文档，添加链接至 Overview 对应的类别名。
可以参考：
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/api/paddle/Overview_cn.rst and inspect how the existing API categories link to individual Chinese and English pages. Add the inplace concept and a separate Inplace API category, then link each Inplace API page to that category. Done means the overview and all relevant language-version documentation pages contain the requested links.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100