Skip to content

基于 CMake 的文档构建流程优化 - #762

Closed
RedContritio wants to merge 1 commit into
PaddlePaddle:masterfrom
RedContritio:doc_build_rfc
Closed

RedContritio wants to merge 1 commit into
PaddlePaddle:masterfrom
RedContritio:doc_build_rfc

Conversation

@RedContritio

Copy link
Copy Markdown

PR types

Others

PR changes

Docs

Description

添加《基于 CMake 的文档构建流程优化》RFC

@sunzhongkai588 @SigureMo

@paddle-bot

paddle-bot Bot commented Nov 28, 2023

Copy link
Copy Markdown

你的PR提交成功,感谢你对开源项目的贡献!
请检查PR提交格式和内容是否完备,具体请参考示例和模版。
Your PR has been submitted. Thanks for your contribution!
Please check its format and content. For this, you can refer to Template and Demo.

@jzhang533

Copy link
Copy Markdown
Collaborator

先随便写一写。在真正动手前,我觉得还是需要更深入的看看现状问题,和设定合理的目标。

  • Better Layout of Docs Repository
    可以借这个机会,看看比较合理的Docs仓库的目录结构应该是什么样的,建议调研看看其他的类似的开源项目的文档的代码仓库的目录结构的设置,现在的Docs仓库的目录结构和脚本命名,多少会让人感到困惑。

  • Refactor (or Recreate) documents building toolchain and workflow
    整个building toolchain的重构,是选用cmake作为构建系统,还是有其他更合理的构建工具(比如:sphinx-build)值得再深入对比看看,也许会有更合适的workflow。 另外,我了解,从内容到官网的过程中,现状应该是有一部分的构建工具,并不在Docs仓库中。

  • Rethinking on single-source-of-truth documents and translations
    我们是不是可以把英文文档当做single-source-of-truth, 把中文文档当成是其翻译,来重新看看目前的中文文档的生产的workflow,例如:是否有可能,用自动化工具构建好初始版本的中文文档(其内容是英文的), 开发者只需要根据这个初始版本来进行翻译工作就可以了。

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@luotao1 luotao1 closed this Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants