Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add autosync warning #7

Closed
wants to merge 1 commit into from
Closed

Conversation

hhio618
Copy link
Contributor

@hhio618 hhio618 commented Nov 29, 2020

@@ -1,2 +1,5 @@
> ## ⚠️ warning!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want this warning in the intro page for Telliot.
Some of our team members are not familiar with github so because of this I will also create another Gitbook space https://docs.telliot..tellor.io so the message in the Telliot intro could be something like:

> ## ⚠️ Note!
Telliot docs are synced from the project repository. 
To Edit visit:
[Telliot gitbook space](https://docs.telliot..tellor.io)
or
[Telliot github repo](https://github.com/tellor-io/telliot/docs)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so where exactly I need to put this warning? Do I need to add an intro document in Telliot repo docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes the note should be in the Telliot docs. I think in the main README.md which is usually the entry point for all docs. Not sure how would that look like in gitbook, so maybe best to add this note once we organise the docs a bit better

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I create a PR in Telliot repo @krasi-georgiev, so we can close this one if no longer needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants