[Meeting] API Meeting 7

[johncmanuel]

🙋 Participants

@sidvasu @johncmanuel @andrewasg11 @EthanThatOneKid

📍 Meeting location

CS-401

🗓️ Meeting date and time

Apr 25, 2024 @ 4:30 PM

⏱️ Estimated meeting duration

45 minutes

📋 Meeting agenda

• Welcome new and returning participants.

🚀 Meeting updates

• We discussed implementation of technical docs for API project

• We will be using GitHub's wiki feature in the repository to store the technical docs

• Covers technical aspects of the project architecture

  • tech stack
  • database schema
  • services
  • setup
  • and more...

• As well as other aspects such as:

  • purpose and intentions
  • how to use the API
  • business aspects
    • who is our target audience? etc.

• Purpose of docs

  • Help new and future maintainers onboard faster and saves extra time during meetings that can be used to make progress

• Process for creating the technical doc:

1. Utilize previous documentation
2. Create rough drafts in Google Docs
3. Use pull requests to submit final drafts to wiki

• Notes:
• Andrew thinks we should brainstorm questions and other things that the documentation should address.
• Andrew thinks we should follow the agile methodology for documentation (i.e list requirements, etc.).

😸 Action items

• [] Andrew, Siddarth, and John will start outlining the important information for the technical doc and work on filling them out.

✨ Meeting wrap-up

• Next meeting: TBD
• Adjournment time: 5:15 PM

[johncmanuel]

Rough draft to the technical doc: https://docs.google.com/document/d/11ZM58f17Cj2UYah00LBHb-nDCBTJbUxo4d5Q0BJP_AA/edit?usp=sharing