Setup with gotbook and remove unneded files

[hhio618]

Description

Add warning to README.md
Add intro to Gitbook doc

Refs

#268
TellorDocs#7

[coveralls]

Pull Request Test Coverage Report for Build 394496586

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.05%) to 36.318%

---

Totals
Change from base Build 392040541:	0.05%
Covered Lines:	1525
Relevant Lines:	4199

---

💛 - Coveralls

[krasi-georgiev]

Thanks, can you create a gitbook space from your local branch so we can preview this and future changes before merging.

Maybe create a gitbook space linked to your main repo and can just merge this and future PRs there so we can preview latest changes

Can you also add in this PR the .gitbook config file to adjust that the root folder is ./docs

[hhio618]

I made required changes.
Please see Gitbook space here

[krasi-georgiev]

Thanks, we are getting there.

Can you also add the changelog as this is also usefull to keep in the logs.

In a follow up PR would be interested to see how can we avoid maintaining a SUMMARY.md file , I guess naming the files properly with some numbers in front would be enough to organize the pages nicely.

[hhio618]

In a follow up PR would be interested to see how can we avoid maintaining a SUMMARY.md file , I guess naming the files properly with some numbers in front would be enough to organize the pages nicely.

Ok, naming seems to be a good idea to me too. Also, to achieve this we need to update GitHub action in TellorDocs repo too.
I think we can remove SUMMARY.md in this PR then.

[krasi-georgiev]

Ok, naming seems to be a good idea to me too. Also, to achieve this we need to update GitHub action in TellorDocs repo too.
I think we can remove SUMMARY.md in this PR then.

yes lets do that and just set the root folder through the .gitbook config file

I want to avoid maintaining the summary file because it will be error prone. so easy to forget when you add/remove/rename files.
For now lets just set the root folder through the .gitbook file and in a follow up PR will arrange the files. We need to merge few of those and do a bit of refactoring in general.

[hhio618]

For now lets just set the root folder through the .gitbook file and in a follow up PR will arrange the files. We need to merge few of those and do a bit of refactoring in general.

Ok, I just did that. I believe we need a summary and readme in .gitbook.yaml if we want Telliot docs to be compatible with Gitbook, otherwise we need to have our warning in docs/README.md too.

[krasi-georgiev]

Ok, I just did that. I believe we need a summary and readme in .gitbook.yaml if we want Telliot docs to be compatible with Gitbook, otherwise we need to have our warning in docs/README.md too.

What do you mean by compatible with gitbook? But yes please move the warning in docs/REA...

[hhio618]

What do you mean by compatible with gitbook? But yes please move the warning in docs/REA...

done
I actually checked this, there is nothing to worry.

[krasi-georgiev]

Oooh I just realised that you can even delete the README.md in the root folder as github will show the one from docs/README.md

see here:

If you put your README file in your repository's root, docs, or hidden .github directory, GitHub will recognize and automatically surface your README to repository visitors.

https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes#about-readmes

[krasi-georgiev]

Yep looking good, really glad how simple it is now. Thanks for doing this!

Now lets see how the sync will work.

[hhio618]

You're welcome! Thanks for your help!
I think we need two other PRs.

1. first for arranging files inside docs folder
2. second updating GitHub action to add these arranged files to table of contents

[krasi-georgiev]

yep, I would like to do a bit of refactoring of the text as well, but let's fix and test the auto-sync first. Btw I have sent you a request to chat on google hangout, it might be easier and quicker to sync for the last PR. Or if you use any other chat client let me know where to find you.

[hhio618]

Ok, sure. can you please ping me on Discord or Telegram?
handle: @hhio618