Ensembl project

AI-generated Key Takeaways

This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers.
The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course.
Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding.
This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months.

This page contains the details of a technical writing project accepted for Google Season of Docs.

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
Authentication info
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.