关于文档若干改进
fduxiao opened this issue · comments
xiao commented
- Quick start里面不要加入
高手可以跳过
之类字眼,技术文档应该严肃。 - 公开文档的源代码(这样遇到以上问题可以直接交PR)
huangyoukun commented
1.文档已更新~
2.考虑过文档也放在github上来,但目前文档是动态生成的(左目录+上导航),并不是静态文件,放上来阅读性会比较差,请理解。文档有问题可以直接提交issue给我们,第一时间更新。
xiao commented
其实我倒是觉着动态生成也没大问题,很多开源项目都是这样的,另外开源docs的好处还有一个是方便用户添加各种tutorial(go pytorch里都有很多这样的),不如考虑在这个仓下面加一个tutorial方便其他人添加?
Zhaofeng Miao commented
感觉可以把教程和手册开源出来给大家更改 @huangyoukun ,主页可能有开放平台的原因不好开源,但是这两个文档页应该是可以的。如果ok的话,我可以来搞一下
huangyoukun commented
@mapleeit 可以啊,开吧