Telliot: 将文档转换为 gitbook 格式并创建一个 GH 操作每日任务，以将所有文档从矿机存储库复制到主 Tellor 文档存储库中。

再想一想，更好的用户体验是将所有文档保存在一本 github 书中，而不是让人们在书籍之间跳转，因此为了实现这一点，我们应该：

• 仍然将所有与矿工相关的文档保留在矿工存储库中（更容易使文档与代码更改保持同步）
• 创建每日 GH 操作 cron 任务，将矿工文档从这里复制到主 Tellor 文档存储库。

我正在为这个新想法重命名标题。

一个非常重要的警告是在主 Tellor 文档存储库中放置一个非常明显的注释，即对于矿工文档更改，PR 应该在矿工存储库中打开，而不是在文档存储库中打开，否则更改将被日常同步任务覆盖。

这个 GH 动作似乎是要使用的动作
https://github.com/repo-sync/repo-sync

所以这个想法是：

1. 一个 PR 将所有文档从https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation到/docs/miner-documentation文件夹中的这个 repo。
2. 另一个 PR 将/docs/miner-documentation中的文档与/docs的现有文档合并，并将它们转换为 git book 格式。
3. 将根 README.md 和 CHANGELOG.md 移动到 docs 文件夹中，然后留下一个指向 gitbook 的链接。
4. 另一个 PR 设置repo-sync/repo-sync以将docs文件夹从这个 repo 同步到https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
5. 另一个 PR 添加注释一些非常明显的警告，不要直接编辑https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation并编辑此 repo 中的文档，而不是与主文档 repo 自动同步。

使用此工作流程，可以很容易地使文档保持最新状态，但仍会为用户提供一个网站来阅读整个文档。

这需要在https://github.com/tellor-io/TellorMiner/issues/282之后或一起完成

问题状态：1.开放2. 开始 3. 提交 4. 完成

__这个问题现在附有 14.0 TRB（435.58 美元 @ 31.11 美元/TRB）的资金。__

• 如果你想解决这个问题，你可以在 Gitcoin 问题详细信息页面上“开始工作”。
  
  
  
  • 想插手吗？ 在此处添加您自己的贡献。
  
  
  • 问题？ 查看Gitcoin 帮助或Gitcoin 聊天
  
  
  • 在Gitcoin 问题浏览器上提供 1,204,490.47 美元的更多资金支持的 OSS 工作
  
  

问题状态：1. 开放 2.开始3. 提交 4. 完成

__工作已经开始__。

这些用户都声称他们可以在 265 年，12 个月后完成这项工作。
请在下面查看他们的行动计划：

1) sebastiantf已申请开始工作_（仅限资助者：批准工人|拒绝工人）_。

使用 Github Actions 似乎是一项简单的任务。 我会尝试这样做
2) developerfred已申请开始工作_（仅限资助者：批准工人|拒绝工人）_。

我很想做这个可移植性，我已经有 gitbook 的经验，而且我最近在处理一个 Tellor golang 问题
3) echolon166已申请开工_(仅限资助者：批准工人|拒绝工人)_。

我想协助您完成这项任务。 我将遵循 krasi-georgiev 在问题中给出的解释，并将文档转换为 gitbook 格式并根据需要创建 github 操作任务。
4） manyrios已申请开始工作_（仅限资助者：批准工人|拒绝工人）_。

看起来很有趣我想试试
5） hhio618已获准开始工作。

好吧，看起来很简单。 我们可以轻松地从代码中自动生成一些文档，就像 Thanos 所做的那样。

在 Gitcoin 问题详细信息页面上了解更多

1. one PR to move all docs from `https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation` to this repo in the `/docs/miner-documentation` folder.

2. Another PR to merge the docs from `/docs/miner-documentation` with the existing docs in `/docs` and convert them into the git book format.

嘿@krasi-georgiev。 上面的 PR(#298) 会做这些。
另外，我检查了repo-sync/repo-sync 。 恐怕这是为了同步两个具有共享提交历史的存储库。 我将提交另一个 PR 来解决我们在这里需要的文件夹同步问题！

谢谢，你对自动同步有什么想法？

我现在正在测试这个 GitHub 操作方法：
每 1 小时：
1. 克隆https://github.com/tellor-io/telliot
2. 使用 md5 哈希将TellorDocs/miner-documentation文件夹与telliot/docs进行比较。
3. 如果有任何差异，则 -> 更新TellorDocs/miner-documentation
4. 将更改推送到TellorDocs库

1. 将更改推送到 TellorDocs 存储库

我们只希望该工具打开 PR，而不是直接推送，以便我们可以看到更改并手动批准和合并。

顺便说一句，我只记得一所大学为类似的事情做了这个脚本，所以也许你可以从那里采用一些逻辑。
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

谢谢你的提示。 我刚刚提交了另一个PR 。

问题状态：1. 开放 2.开始3. 提交 4. 完成

__14.0 TRB（361.72 美元 @ 25.84 美元/TRB）的作品已由__提交：

• 在 Gitcoin 问题详情页面了解更多
• 想插手吗？ 在此处添加您自己的贡献。
• 问题？ 查看Gitcoin 帮助或Gitcoin 聊天
• 在Gitcoin 问题浏览器上提供 1,197,918.50 美元的更多资金支持的 OSS 工作

现在完成了