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

Please add link to documentation #213

Closed
eshellman opened this issue Mar 24, 2021 · 5 comments
Closed

Please add link to documentation #213

eshellman opened this issue Mar 24, 2021 · 5 comments

Comments

@eshellman
Copy link
Contributor

Rupert asked me to take a look at Thoth, but I have been unable to find any documentation.

@ja573
Copy link
Member

ja573 commented Mar 24, 2021

If you are interested in the API, the easiest is to inspect the schema with graphiql at https://api.thoth.pub/graphiql (click on "Docs" at the top right)

@eshellman
Copy link
Contributor Author

No, I mean Thoth. Adding a link to https://api.thoth.pub/graphiql would be a good addition; that schema's documentation is telegraphic.
What user stories are addressed by the api? Maybe a few example queries for the live dataset would help?
Is there a roadmap?
What set of problems is Thoth designed to solve?
Are there design documents anywhere? User requirements?

@ja573
Copy link
Member

ja573 commented Mar 25, 2021

So far everything is work in progress and that type of documents are scattered. The project wiki could be a good place to start (though it needs tidying up) - it provides information of the data formats and platforms Thoth will output and how it links to the scoping report

@eshellman
Copy link
Contributor Author

That's what I was looking for! I will submit a PR.

@ja573
Copy link
Member

ja573 commented Mar 25, 2021

Great, thank you! If you do, please use develop as the base branch (instead of master) - we use git flow as our branching model. (We don't yet have a PR template.)

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

No branches or pull requests

2 participants