Docs tutorials - terrytaylorbonn/auxdrone GitHub Wiki
25.0208 Gdrive
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.
(need to update this section)
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).
- Copy and paste (where appropriate), not endless (error prone) typing.
- Explain code without typing it out.
- Comment out code that is temporarily not needed.
First deploy the minimal functional code (stage1):
- Deploy frontend React to Render 1
- Deploy backend Node/Express to Render 2
- Setup MongoDB
Then deploy for stage 2, 3, until finished.
Understand the top level, then drill down into the lower levels for the backend (in this example from #901 Express, Node, and Mongo)...
... and the frontend (React).
I'd reinterpret some common concepts. For example: An detailed explanation (draft) of an MVC implementation example that explains the confusing terminology (see #901 for details).
Backend Developer Roadmap 2025: The Complete Guide Hayk Simonyan https://www.youtube.com/watch?v=I-dwsMkIYDo
Session Vs JWT: The Differences You May Not Know!
20 System Design Concepts Explained in 10 Minutes
https://www.youtube.com/watch?v=i53Gi_K3o7I
https://www.youtube.com/watch?v=fyTxwIa-1U0
systems design
https://www.youtube.com/watch?v=F2FmTdLtb_4
Top 6 Most Popular API Architecture Styles ByteByteGo https://www.youtube.com/watch?v=4vLxWqE94l4
Front-end web development is changing, quickly Fireship https://www.youtube.com/watch?v=TBIjgBVFjVI