update api docs - Githubissues

openproblems-bio / website

Website hosted at https://openproblems.bio

Creative Commons Attribution 4.0 International

3 stars 7 forks source link

update api docs #257

Closed rcannood closed 1 year ago

rcannood commented 1 year ago

Describe your changes

Extend the documentation on designing the task API
Add documentation on writing the process dataset component

Issue ticket number and link

~Closes #xxxx~

Checklist before requesting a review

[x] I have performed a self-review of my code
Check the correct box. Does this PR contain:
- [ ] Breaking changes
- [ ] New functionality
- [ ] Major changes
- [x] Minor changes
- [ ] Bug fixes
[x] Proposed changes are described in the CHANGELOG.md
[x] CI Preview succeeds and looks good!

github-actions[bot] commented 1 year ago

rcannood commented 1 year ago

Hey @KaiWaldrant and @mumichae !

I wanted to write the section on "Selecting the datasets", but ended up reworking the section on "Designing the API". Could you have a quick look through the new version to see if you agree with the new version?

Thanks in advance :)

rcannood commented 1 year ago

Going to merge this PR so Scott continue with alpha testing.