Sync telliot docs using Github actions #5
Conversation
.github/workflows/main.yml
Outdated
| @@ -0,0 +1,47 @@ | |||
| # Sync miner docs from https://github.com/tellor-io/telliot/tree/master/docs in miner-documentation folder in the current repo | |||
There was a problem hiding this comment.
We should rename the Miner folder to Telliot and will refactor the docs to explain that one of the tasks that Telliot does is mining.
.github/workflows/main.yml
Outdated
| if [ "$TELLIOT_MD5" != "$CURRENT_MD5" ]; | ||
| then | ||
| sed -i 's/(/(miner-documentation\//g' ./telliot/docs/INDEX.md | ||
| python .github/workflow/update-summary.py ./telliot/docs/INDEX.md |
There was a problem hiding this comment.
Why is this needed?
There was a problem hiding this comment.
I put an INDEX.md file in Telliot docs folder which contains Telliot table of content. This way the main docs can be in sync with Telliot table of content and we don't need to manually edit the SUMMARY.md file every time the auto-sync process creates a PR.
There was a problem hiding this comment.
Aah yeah I see what you mean. Lets call it SUMMARY.md to be consistent and also when opening the Telliot dedicated gitbook space it will be used as well.
There was a problem hiding this comment.
Also in the Telliot repo we would need to add a .gitbook.yaml to specify the root folder and the location of the summary there.
https://docs.gitbook.com/integrations/github/content-configuration#summary
There was a problem hiding this comment.
Ok, then I changed the action to handle a SUMMARY.md file.
|
I don't have merge access to this repo but asked for access and will merge soon |
|
Thanks! |
Refs
telliot#268