-
Notifications
You must be signed in to change notification settings - Fork 32
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.
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
建议不要用issue做文档 #13
Comments
是的,我在本地写文档时是在 /doc 目录下写 *.md 的,不过只是作为我自己的书写环境和存档,不会 push 到 origin。用 Issue 写文档也确实有不妥的地方,但考虑到以下一些原因,我还是这样做了。
由于这个项目的规模有限,用 Issue 写文档的缺陷还不是那么明显。看到 Seajs 现在还在用 Issue 写文档,我也就安心了。 当然对于有一定规模的项目,我还是会用公开的 repo 来组织文档。比如 CMUI/demo 和 CMUI/doc。 |
我很想开发一个工具,把本地的 |
不知道啊。要实现的话也不是特别复杂,有现成的github api可以读写issue。 |
具体怎么组织文档我还没想好,估计最后多半还是会采用 Issue 来发布。我现在还没有概念,只能在实践中慢慢摸索和体会了。 |
Add source files of documentation, resolve #13.
我后来发现两者不矛盾——可以把文档的源文件存在 repo 里,然后只对外公布 issue 形式的文档。 |
不过这需要你手动维护啊。 |
对,所以我需要写个工具帮我自动同步。 |
文档可以直接在repo里开/doc目录,存成 *.md 即可。
这样避免和真的issue混在一起。
The text was updated successfully, but these errors were encountered: