[Topic DIscussion] deepin 文档架构重整
Tofloor
poster avatar
longlong
deepin
Community Developer
2023-02-22 17:13
Author

大家好,我是deepin 文档SIG的负责人,也是deepin wiki的参与者,现阶段准备对deepin提供的文档进行重整,整理后的文档架构如下:

image.png

目标是分离各个文档的功能,能给予新手小白和系统老鸟一个完美的文档体验。目前deepin wiki和guide还在改造过程中,dtk的doxygen文档已经初步发布,还在不断完善中。欢迎大家加入deepin wiki SIG 以及 deepin doc doc go SIG为我们的wiki和文档做出贡献

Reply Favorite View the author
All Replies
2 / 2
To page
一介书生
deepin
2023-02-27 05:53
#21

agree

Reply View the author
pzm9012
Moderator
2023-02-28 02:52
#22
myml

https://guide.deepin.org 已上线,大家一起 添砖加瓦(github)

tail

这个用的是VitePress吧

Reply View the author
longlong
deepin
Community Developer
2023-02-28 18:06
#23
Fredoong

改动得挺好的,我之前想编辑wiki,结果大家把东西放的乱七八糟,我根本不知道我写的东西应该放在哪个地方,所以我直接放弃了编辑wiki。

可以参与编辑了

Reply View the author
myml
Super Moderator
Developer
2023-03-02 17:45
#24
pzm9012

这个用的是VitePress吧

对的,这个挺好的

Reply View the author
pzm9012
Moderator
2023-03-02 19:04
#25

有个问题想确认一下,wiki现行分类里面各个类别是只包括概念性词条,还是也可以包括实际使用中解决问题的词条?我看硬件下面的词条全是偏概念的。

Reply View the author
longlong
deepin
Community Developer
2023-03-02 23:30
#26
pzm9012

有个问题想确认一下,wiki现行分类里面各个类别是只包括概念性词条,还是也可以包括实际使用中解决问题的词条?我看硬件下面的词条全是偏概念的。

解决问题的教程放在HOWTO和FAQ中,WIKI里面只会存在对某一词条的解释

Reply View the author
scalaz
deepin
2023-03-03 19:31
#27

agree

Reply View the author
dgmenghuan
deepin
2023-03-08 17:51
#28

agree

Reply View the author
li******04@gmail.com
deepin
2023-03-14 06:22
#29
Reply View the author
魔法师
deepin
2023-11-22 01:11
#30

不得不说,你确实是引入了不错的 wiki SGI 系统,但你整合的 wiki 具有像论坛一样的分区,虽然这类需求虽然比较少见,但 wiki 不限于 wiki:

  • 你有一样的想法,可以参考如下 wiki 结构,并尝试在 WIKI 中使用下拉选项提供易用的分区入口,像做产品一样的文档系列
  • https://wiki.sipeed.com/soft/Lichee/zh/Zero-Doc/Drive/GPIO_file.html

注:不管是何种形式,都可以称之为 wiki,更好的文档架构产生的 wiki 形式也具有一种魔力

其:https://www.bilibili.com/video/BV1o34y1h76N
是我自认为一种的简单 wiki 形式,由于历史原因,该项目并不是特别明确为一个 wiki ,而是一种易于检索的信息存储服务。

Reply View the author
2 / 2
To page