developmentseed / eoAPI

[Active Development] Earth Observation API (Metadata, Raster and Vector services)
https://eoapi.dev
MIT License
196 stars 21 forks source link

Docs/update docs #96

Closed zacharyDez closed 1 year ago

zacharyDez commented 1 year ago

Improve Onboarding Documentation for eoAPI

Description of Changes

This PR improves the eoAPI onboarding documentation to make it easier for users to get started. The changes are as follows:

  1. Getting Started Section: A new "Getting Started" section has been added to the README. It includes a guide on launching the application locally and loading data into eoAPI by referencing the demo documentation. The "Project Structure" section has been removed from the README to prevent potential misinformation due to changes in the deployment structure.

  2. Services Overview: A new concise "Services Overview" section has been created that introduces the different parts of eoAPI. It also includes links to the corresponding API documentation. Additionally, a separate services-details.md file has been created, which includes the initial information provided in the README.

  3. Why Use eoAPI: The README now includes a new section, "Why Should You Use eoAPI", which lists reasons and justifications for using eoAPI.

These changes aim to provide a smoother onboarding experience and more effective use of eoAPI by new users.

I am unsure if the Why should you use eoAPI section is sufficient sufficient to close #69. We might want to review whether it is helpful for a developer new to eoAPI.

The Getting Started section addresses some of the needs of #95, but refers to the current demo documentation for data ingestion.

Checklist:

zacharyDez commented 1 year ago

@vincentsarago is there anything we should change before merging?

vincentsarago commented 1 year ago

@zacharyDez you can go ahead and merge 🙏