This page contains the details of a technical writing project accepted for Season of Docs.
- Open source organization:
- Technical writer:
- Project name:
- REST API documentation
- Project length:
- Standard length (3 months)
Enhance the developer user guide for using the Ensembl REST API
Main focus -- Provide a more user friendly introduction/getting started section.
Proposed implementation is based along the lines of these doc pages:
Includes these sections (high level view):
Overview of what this API provides in practical terms
Short intro to REST
A quick example
Introduction to how the URLs are structured using various HTTP methods
Info on the required and optional parameters and where they are found in the auto-generated endpoint documentation.
Link to the following training page: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Info on helper_functions that are used in the training course
Depending on complexity of the topics listed in the main page, some topics may need to link to subsequent detail pages.