1b Docs - terrytaylorbonn/auxdrone GitHub Wiki

25.0223

4.1b Docs

25.0208 Gdrive

Docs/tutorials (for LLM)


My approach to creating docs and tutorials.

  • No AI (requires real intelligence).
  • First create lab notes (docx's in Gdrive) during hands-on exploration of topics.
  • After organization and content have stabilized (requires time):
    • Convert the lab notes into user docs (docx's).
    • Publish docx user docs as webcontent.
    • Train the LLM on the docx, swagger, UI, etc content (see 5 AI LLM (TODO)).

My tutorial style:

  • Start with Youtube video, templates (from Vercel, etc), or simple GPT/Copilot
  • GIT code backups
  • The goal of lab notes is enabling to reproduce later
  • Eventually mix the content of docx's (future)
  • Top down approach to creating demo content (see "CREATING (REPLICATING) / DOCUMENTING DEMOS" below).
    • First deploy a minimal viable app.
    • Then fill out the app in stages (deploy often to verify).
    • Use AI wherever possible.





CREATING (REPLICATING) / DOCUMENTING DEMOS

(need to update this section)

  • Docx files in the Gdrive (these are for now basically my lab notes)
  • Git repos

The following summarizes the API sandbox approach to documentation.

1 Updated Gdrive docx's as the source of truth

Youtube videos do not get updated. You need the details, updated regularly, in print. In this wiki the docs are currently Gdrive docx's that are my lab notes (that could be used to create end user docs).

2 GIT code for each chapter

  • Copy and paste (where appropriate), not endless (error prone) typing.
  • Explain code without typing it out.
  • Comment out code that is temporarily not needed.

3 Code deployed in stages

First deploy the minimal functional code (stage1):

  • Deploy frontend React to Render 1
  • Deploy backend Node/Express to Render 2
  • Setup MongoDB

image

Then deploy for stage 2, 3, until finished.

4 "Drill down" into the code

Understand the top level, then drill down into the lower levels for the backend (in this example from #901 Express, Node, and Mongo)...

image

... and the frontend (React).

image

5 Use AI wherever possible

6 Intro the ecosystem and Youtube authors/videos




⚠️ **GitHub.com Fallback** ⚠️