csu-thesis icon indicating copy to clipboard operation
csu-thesis copied to clipboard

Wiki: 考虑搬运部分内容至wiki页面

Open Edwardzcn opened this issue 4 years ago • 1 comments

目前经过 @loctempt 的填充,我们的开发者文档以及Git指导都在项目docs目录下,我考虑可以向项目Wiki进行迁移。

个人认为主要有以下两个优势:

  • Wiki界面可以生成侧栏,使文档目录更加清晰,对不了解Git环境配置、TeX环境配置等多项内容的新人更加友好,同时也方便查阅。
  • 可以进行在线编辑,撰写Wiki。

不过考虑到有一些大型项目比如Angular也不提供Wiki页面,而是保留仓库中的docs目录,这种方式也不是最优,我能想到的一个缺点就Wiki从docs目录迁出会导致不易同时维护项目中的文档内容,虽然说从git底层看,二者并无区别,参见本地添加或编辑wiki页面

可以略作讨论,决定是否迁出。

Edwardzcn avatar Jan 29 '21 03:01 Edwardzcn

用wiki的话逻辑更清晰些,就感觉用wiki不错,到时候README里加个链接跳转过去,写明规则,维护起来也挺方便

loctempt avatar Jan 29 '21 03:01 loctempt