PaddlePaddle / PaddlePaddle/docs
Migrate Paddle-Inference docs into this repository
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 284
- Forks
- 906
- PR merge metrics
- No merged PRs in 30d
Description
Status update： hold
现在Paddle-Inference的文档放在了Paddle-Inference-Demo进行管理，最新的Paddle-Inference的文档放在了docs-official目录下，跟 @qingqing01 简单讨论后，觉得这些文档放到本仓库下统一管理，会方便以后的文档维护，上线。
现在我想到的收益是：
- 提升文档发布的质量和效率。
例如，现在线上的Paddle Inference文档，因为没有及时进行切分支等操作，导致，线上的默认文档并非最新文档。
Paddle Inference的文档的发布，整合进当前飞桨框架的版本发布和文档发布的流程后，能够复用现有的release process。
- 复用现有docs 仓库的CI和测试流程。
这可以提升Paddle Inference文档的质量。
- 合并的持续长期的维护上的便利
其他待讨论问题
- 现有的Paddle-Inference-Demo仓库，后续的定位，是否就定位为仅存放Demo。
相关背景
我们还计划将Paddle Inference的安装包合并到Paddle主框架的安装包。 @dingjiaweiww @JZZ-NOTE 正在进行调研中。
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 by reviewing the current documentation in Paddle-Inference-Demo/docs-official and the existing documentation release, CI, and testing processes in this repository. Clarify the proposed migration scope and the future role of Paddle-Inference-Demo before making changes. Done means the migration plan is agreed and the documentation is integrated into the repository’s release and validation workflows.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100