Convert the docs into gitbook format and create a GH actions daily task to copy all docs from the miner repo into the main tellor docs repo. #268
Comments
On a second thought a much nicer user experience would be to keep all docs in a single github book rather then making people jump between books so to achieve this we should:
I am renaming the title to this new idea. One very important caveat is to put a very visible note in the main tellor docs repo that for miner docs changes a PR should be open in the miner repo and not in the docs repo as otherwise the changes will be overwritten from the daily sync task. |
this GH action seems to be the one to use |
so the idea is:
With this workflow, it will be quite easy to keep the docs up to date, but still provide a single website to the user to read the entire document. This needs to be done after or together with #282 |
Issue Status: 1. Open 2. Started 3. Submitted 4. Done This issue now has a funding of 14.0 TRB (435.58 USD @ $31.11/TRB) attached to it.
|
Issue Status: 1. Open 2. Started 3. Submitted 4. Done Work has been started. These users each claimed they can complete the work by 265 years, 12 months from now. 1) sebastiantf has applied to start work (Funders only: approve worker | reject worker). Seems like a straightforward task with Github Actions. I shall try doing this I'd love to do this portability, I already have experience with gitbook and I recently worked on a tellor golang issue I would like to assist you with this task. I will follow the explanation given by the krasi-georgiev in the issue, and will convert the docs into gitbook format & create the github actions task as you wanted. Looks very interesting I would like to try it Ok, seems straightforward. we can easily auto-generate some docs from the code like what Thanos did. Learn more on the Gitcoin Issue Details page. |
Hey @krasi-georgiev. The above PR(#298) will do these. |
Thanks, what do you have in mind for the auto sync? |
I'm testing this GitHub action aproach right now: |
Instead of a direct push we just want the tool to open a PR so we can see the changes and will manually approve and merge. |
btw I just remembered that a college did this script for a similar thing so maybe you can adopt some of the logic from there. |
Thanks for the tips. I just submitted another PR. |
Issue Status: 1. Open 2. Started 3. Submitted 4. Done Work for 14.0 TRB (361.72 USD @ $25.84/TRB) has been submitted by:
|
This is now done |
At the moment the miner repo has some docs under
docs
folder and others are kept in the main docs repo at https://github.com/tellor-io/TellorDocs. I think the main docs repo should keep docs related to the project itself and an overview of all components and miner specific docs(how to build, how to run etc) should be kept here in the miner's repo. The main docs repo will then just have a link to the miners github book docs.This has 2 main benefits
Follow the issue
A solid command of the English language is important for this issue
The text was updated successfully, but these errors were encountered: