Documentation Notes

Owned by Mikah Pinegar
Last updated: Nov 14, 2024 by Adam Smith
1 min read

10-18-24

Updates

  1. Adam

    1. Doing readme for the selector

  2. Ted

    1. Made a shared components doc

  3. Ravi

    1. Added multipart body snippet

  4. Vyshnavi

    1. I’ve been working on updating the README files for the dst-selector-api and history-api. I’ll finish the documentation soon and share the link in the DST dev channel.

  5. Ted

    1. Updated testing docs

      1. How to run local, breakdown of tests, pipelines, detailed commands, code coverage, etc

    2. Updated the shared react components readme

      1. Setting up repo

      2. Using command to make new component

  6. Akshat

    1. No updates

    2. Rafiki db diagram done by mikah

  7. Trevor

    1. No new docs

    2. Will have some soon

    3. Data import wrapped

Still needed

  1. Akshat

    1. New API spec for Rafiki

    2. Will make a doc explaining testing, e2e vs component, type of tests, file locations etc for selector and seedcalc

  2. Trevor

    1. Craft forms API + webhook integration

    2. Add redis docs to DevOps space

  3. Mikah

    1. Testing

    2. CI/CD

09-20-24

Updates

  1. Ravi

    1. Ag IR and Mono cam Readmes

    2. High level Confluence docs around android app creation from the ground up

    3. Added section about bracket confusion to multipart body doc

  2. Ted

    1. Made pirsch docs

Still needed

  1. Adam/interns

    1. Herb lookup tool still needed, squarespace

    2. Update readme for the selector for meaningful developer context

    3. Shared component docs. What frameworks will be used, structure, @Jingtong Xu will need to help with tagging the repo before going live

  2. Mikah

    1. Testing

    2. CI/CD

  3. Ravi

    1. Will add a small code snippet explaining the key changes to the multipart body doc

  4. Ted

    1. Will update pirsch doc with link to pirsch dashboard, add quickstart, and example event calls

    2. Will make a doc explaining testing, e2e vs component, type of tests, file locations etc for selector and seedcalc

  5. Akshat

    1. Rafiki architecture diagrams/docs

    2. New API spec

    3. Will make a doc explaining testing, e2e vs component, type of tests, file locations etc for selector and seedcalc

  6. Vyshnavi →

    1. update readme for selector api to be more dev oriented, history API as well

    2. add a doc about the more technical side of db diagrams, stack, frameworks, middleware, etc. Trevor can add the db diagrams

  7. Trevor

    1. Craft forms API + webhook integration

    2. Add redis docs to DevOps space

08-23-24

Updates

  1. Adam → WP engine docs WP Engine How To will add smart plugin manager stuff

  2. Ravi → multi part body object https://precision-sustainable-ag.atlassian.net/wiki/spaces/AA/pages/606666754 will add the bug that got fixed by accessing array item wrong

  3. Vyshnavi → https://precision-sustainable-ag.atlassian.net/wiki/spaces/AFA/pages/257228801 updated this page with new endpoints, added example requests and responses. will make an overview history doc, and make quick start as short as possible

Still needed

  1. Ted will work on Pirsch

  2. Trevor will do Craft forms API + webhook integration and add redis to DevOps space

  3. Mikah will do CI/CD for tests

  4. Mikah → gates project + rafiki docs

  5. Adam + interns → herbicide lookup tool

  6. Update readme for the selector for meaningful developer context

  7. Vyshnavi → update readme for selector api to be more dev oriented, history API as well

  8. Vyshnavi → add a doc about the more technical side of db diagrams, stack, frameworks, middleware, etc. Trevor can add the db diagrams

  9. Look into android dev things → diagram of how things work, screen grabs from protocol, etc

  10. Ravi → will update readmes on mono cam and ag ir, make confluence docs with high level overviews of the apps + hardware

07-26-24

  1. Mono cam api doc made by Ravi https://precision-sustainable-ag.atlassian.net/wiki/x/XgCHIg

  2. Akshat doc about android oakd integration https://precision-sustainable-ag.atlassian.net/wiki/x/GIC3I

  3. Vyshnavi working on user history docs

  4. Adam will wp engine docs

  5. Ted will work on Pirsch docs for next meeting

  6. Craft forms API + webhook integration

  7. Would be good to add redis to DevOps space

  8. Need more docs for filtering tests, need to add screenshots as well, CI/CD updates for testing

  9. Form body object troubles

  10. 1 week before next docs meeting, send out reminder

Past

  1. Add mono cam on android issues doc

    1. Need to update readmes

  2. Android apps in general

  3. New docs for user history

  4. Seedcalc

    1. is good on docs

  5. Selector

    1. Cypress docs → how to use the gui

    2. Refactor docs for filter sort

  6. WP engine/grow

    1. Need docs for grow

    2. Newsletters should be documented

  7. Documenting api repo and user history changes

  8.