EpistasisLab / EpistasisLab/Aliro
Add REST API docs to the developer's guide
- Dominant language
- JavaScript
- Stars
- 238
- Forks
- 60
- PR merge metrics
- No merged PRs in 30d
Description
The API documentation should be accessible and updated as new endpoints are added.
Need to complete the following steps:
- [ ] Generate the html API guide using the RAML specification for the lab.
- [ ] Ensure all endpoints are documented in the existing RAML spec.
- [ ] Create a RAML spec for the machine API
- [ ] Determine how to best integrate building and deploying the API html page with the existing documentation on GitHub Pages
- [ ] Add the steps to generate the html files from raml to the existing doc builder docker image, output to **target** directory.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.