Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

根据FE/UI/UX设计师要求，整理中英文文档 #462

Closed
3 of 12 tasks
luotao1 opened this issue Nov 14, 2016 · 3 comments
Closed
3 of 12 tasks

根据FE/UI/UX设计师要求，整理中英文文档 #462

luotao1 opened this issue Nov 14, 2016 · 3 comments
Assignees
@llxxxll

Comments

@luotao1
Copy link
Contributor

luotao1 commented Nov 14, 2016 •
edited
Loading

整体要求：

  1. 中英文目录结构统一及规范
  2. 中英文文档内容质量的提高

目录方面的工作：

  • 中英文一级二级目录的确定（优先级最高）。@wangkuiyi @reyoung
    • 目录确定后，是否需要将doc_cn和doc下面的文档和子目录重新归类？重新归类的话，会导致已有很多链接的失效。
    • 目前存在多个目录节点指向同一个页面，最好只保留一份。
    • 中英文顶部导航的问题。（英文已完成 modify first level directory of english doc #478）
  • 中英文目录和文档对应问题。
    • doc_cn下面的目录结构修改成和doc完全一样的。中文缺少的目录，采用软连接到英文目录？
  • 页面锚点作为目录节点出现了，但是到了页面中这些锚点又没有了。（优先级高）
  • 删去所有的内部文档和链接。（优先级高）
  • 生成Source Code注释过程中，存在大量重复的目标链接提示以及warning。（优先级低）
  • 其他小问题：锚点链接与页面链接一样，链接指向错误，标题名称错误等情况。（碰到即解决）

内容方面的工作：

  • 中英文md文档转成rst文档：中文进行中
  • 中英文质量提升：中文进行中

请大家补充
@reyoung reyoung added this to the 0.10.0 milestone Nov 15, 2016
@luotao1 luotao1 changed the title 根据UI/UX设计师要求，整理中英文文档 根据FE/UI/UX设计师要求，整理中英文文档 Nov 15, 2016
@llxxxll
Copy link
Member

llxxxll commented Nov 16, 2016 •
edited
Loading

补充
1、文档语言切换（中/英文）方案：现在实现方式是重写，未来是否可以统一文件名，通过路径名（doc/doc_cn）判断切换。
2、只有中文文档产出，如何处理英文缺失内容：比如中文文档完成，但是英文文档还没有；初步设想方案是直接在英文目录下映射一个中文文档的名字+链接；

@Shi-Liang
Copy link
Contributor

部分目录中的标题与具体文档的标题存在不一致的情况，期望保持一致

@lizhaoch
Copy link

先发布出来，边写边发布吧

@luotao1 luotao1 closed this as completed Dec 8, 2016
zhhsplendid pushed a commit to zhhsplendid/Paddle that referenced this issue Sep 25, 2019
@tink2123 @shanyi15
update api guides for cn (PaddlePaddle#462)
77c85d2
zhhsplendid pushed a commit to zhhsplendid/Paddle that referenced this issue Sep 25, 2019
@shanyi15
update_1.2 (PaddlePaddle#464)
41e6a03 
* add_api_cn (PaddlePaddle#437)

* add gpu benchmark page (PaddlePaddle#436)

* add gpu benchmark

* fix comments

* add chinese link in gen_doc.py (PaddlePaddle#439)

* modified gen_doc.py

* Update gen_doc.py

* update gen_doc.py

* Update mobile doc (PaddlePaddle#440)

* update_en_structure

* update_Paddle_commitid

* delete_DS

* update_mobile_doc

* Update book commit (PaddlePaddle#438)

* update_en_structure

* update_Paddle_commitid

* delete_DS

* update_book_commit_id

* update_api_rst

* Adjust structure of advanced usage (PaddlePaddle#442)

* adjust_structure_of_advanced_usage

* Update paddle_gpu_benchmark.md

* adjust_toctree_hidden

* fix_api_guide

* Update index.rst

* fix deadlinkes (PaddlePaddle#443)

* add_toctree (PaddlePaddle#445)

* adjust_beginners_structure (PaddlePaddle#446)

* adjust_beginners_structure

* Update index.rst

* update install_doc for python3 (PaddlePaddle#418)

* update install_doc for python3

* update python3.5+ info,test=develop

* fix review, test=develop

* fix_pic (PaddlePaddle#447)

* delete en2zn link

* update lod_tensor

* 1207

 1.english api reference links removed
2. formatted

* update transpiler

* update profilse_cn

* Update docker-image instroduce, test=develop (PaddlePaddle#459)

* fix_bug (PaddlePaddle#460)

* [cp2dev]Add avx info 1.1 (PaddlePaddle#279) (PaddlePaddle#451)

* Add avx info 1.1 (PaddlePaddle#279)

* refine avx info representation

* refine avx info representation

* refine avx info representation

* updatetoavx

* fix_AVX

* update_en_api (PaddlePaddle#461)

* update api guides for cn (PaddlePaddle#462)

* Update commit_id of Paddle (PaddlePaddle#463)

* update_en_api

* update_again

* Fix bug (PaddlePaddle#465)

* update_en_api

* update_again

* bug_fix

* fix_2nd
zhhsplendid pushed a commit to zhhsplendid/Paddle that referenced this issue Sep 25, 2019
@shanyi15
update_1.2 (PaddlePaddle#467)
51117e4 
* add_api_cn (PaddlePaddle#437)

* add gpu benchmark page (PaddlePaddle#436)

* add gpu benchmark

* fix comments

* add chinese link in gen_doc.py (PaddlePaddle#439)

* modified gen_doc.py

* Update gen_doc.py

* update gen_doc.py

* Update mobile doc (PaddlePaddle#440)

* update_en_structure

* update_Paddle_commitid

* delete_DS

* update_mobile_doc

* Update book commit (PaddlePaddle#438)

* update_en_structure

* update_Paddle_commitid

* delete_DS

* update_book_commit_id

* update_api_rst

* Adjust structure of advanced usage (PaddlePaddle#442)

* adjust_structure_of_advanced_usage

* Update paddle_gpu_benchmark.md

* adjust_toctree_hidden

* fix_api_guide

* Update index.rst

* fix deadlinkes (PaddlePaddle#443)

* add_toctree (PaddlePaddle#445)

* adjust_beginners_structure (PaddlePaddle#446)

* adjust_beginners_structure

* Update index.rst

* update install_doc for python3 (PaddlePaddle#418)

* update install_doc for python3

* update python3.5+ info,test=develop

* fix review, test=develop

* fix_pic (PaddlePaddle#447)

* delete en2zn link

* update lod_tensor

* 1207

 1.english api reference links removed
2. formatted

* update transpiler

* update profilse_cn

* Update docker-image instroduce, test=develop (PaddlePaddle#459)

* fix_bug (PaddlePaddle#460)

* [cp2dev]Add avx info 1.1 (PaddlePaddle#279) (PaddlePaddle#451)

* Add avx info 1.1 (PaddlePaddle#279)

* refine avx info representation

* refine avx info representation

* refine avx info representation

* updatetoavx

* fix_AVX

* update_en_api (PaddlePaddle#461)

* update api guides for cn (PaddlePaddle#462)

* Update commit_id of Paddle (PaddlePaddle#463)

* update_en_api

* update_again

* Fix bug (PaddlePaddle#465)

* update_en_api

* update_again

* bug_fix

* fix_2nd

* add_release_note
thisjiang pushed a commit to thisjiang/Paddle that referenced this issue Oct 28, 2021
@hp03
export cinnapi shared library (PaddlePaddle#462)
ef0fa7a 
* export cinnapi shared library

* remove core_gather_src
gglin001 added a commit to graphcore/Paddle-fork that referenced this issue Mar 17, 2022
@gglin001
sync api change (PaddlePaddle#462)
8170905 
* sync api change

* rm test_enable_patern UT

* fix typo
AnnaTrainingG pushed a commit to AnnaTrainingG/Paddle that referenced this issue Sep 19, 2022
@lzzyzlbb
Polish code (PaddlePaddle#462)
3e6fb64 
* fix benchmark

* add fomm and stylegan benchmark

* fix version of imageio

* add copyright of psgan, test=document_fix

* add copyright, test=document_fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@llxxxll llxxxll

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@reyoung @llxxxll @Shi-Liang @luotao1 @lizhaoch