Home page

Overall vision

1. autodocs from FastAPI --> OpenAPI format need to be correctly and fully specified:

   • Extensive example not necessarily needed but different UUIDs and parameters mustclearly labeled and typed
   • label endpoints with appropriate tagging to identify clearly what type of endpoint they are and what general purpose they serve
   • Each endpoint, and each parameter of each endpoint should be accompanied with a succinct plain English description of its purpose and usage

2. The structure of this documentation is entirely flexible, so we should take advantage of this by making sure that the documentation accurately reflects intended user flows. New pages can be created to serve specific needs like "getting different rows out of insights grid and getting specific information for each tracker value" which would likely involve a handful of endpoint calls. We should use consistent images and diagrams where needed. It's all markdown under the hood with an array of useful plugins that add advanced capabilities.

3. When endpoints change, the autodocs will update, but obviously we need to make sure that any changes in the fundamental behavior are also tracked and reflected

4. Overall we just need to make sure this accurately reflects to clients and potential clients the API capabilities. There will likely need to be some referencing of Atlas help docs to include conceptual information, or drafting of new conceptual documentation that can help specifically API users understand behaviors that may not be as well explained without the full UI of the webapp, for instance