如何对齐组织中的代码repo和文档repo

[kingsznhone]

从理论上来说代码库应该是研究的唯一真相，文档应该跟随代码库的内容进行跟随。

可是qq-win-db-key的README指示文档repo可能是最新的，并且qq-win-db-key库中也有自己的一些文档

关于这个对齐的问题，有两种方案，一种是移除代码repo里的大量文档，只保留必要的构建和使用文档，概念性和教程性的文档全部移动至文档repo。

另一种方案是将文档系统整合进qq-win-db-key，通过CI检测commit自动构建github page，将这个库作为一个主力repo，更新维护的时候顺便把文档也更新了。

另外我看到组织里有一些可能废弃的repo，或许做好合适的archive标注或者隐藏或者直接移除，能够在一定程度上降低网友寻找解决方案时的认知负担

@Young-Lord

[Young-Lord]

我希望的形态是全部移动到文档库里，毕竟网页能提供很多仅 Markdown 实现不了的效果（比如：hash 计算器、提问式导航），而且代码和文档是比较紧密关联的。

刚处理了四个废弃的 repo，剩下的应该都还有一些价值，可以保持开放以供后续讨论。

[kingsznhone]

我看到文档网站是用vitepress从md页面定义自动生成的，如果要实现网页内计算器的话，要在md里嵌入vue代码吗？

[Young-Lord]

如果要实现网页内计算器的话，要在md里嵌入vue代码吗？

是的，当前已经有这样做的例子了：
https://github.com/QQBackup/QQDecrypt/blob/043d53ed6a06f71a7949270509d5cc0286212dd8/docs/decrypt/NTQQ%20(Android).md?plain=1#L23

[kingsznhone]

初步的代码repo和文档repo清理完成了