-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation
This page describes the doc tools I am trying out. The tools change quickly. My notes are in websites_public_v11_24.0308.docx in Gdrive.
Most of the documentation for projects I have worked on the past 8 years have all been confidential and/or for internal use only, so this site is good chance to make something public.
Content:
- Main docs
- ziptieai.com/org
- Gitbook
- Code/API docs
- Code/API sources (Git, Postman and Swagger)
Provides a very organized big-picture conceptual intro to AI drones (something that I have not seen elsewhere). I have probably made some mistakes, but with time I will get everything right.
Contains step-by-step detailed documentation. I am working alone without (human) assistance (AI like google search, StackOverflow, and Youtube make working alone possible), so accurate, useful documentation is a critical part of this project for me. The .docx files contain detailed instructions (details are everything for this project).
- Steps are auto-numbered in docx's.
- Source of truth are the docx's. I use/update them constantly. Good search functions, pasting screenshots is easy, etc (better than Github). Youtube videos, like Git, get outdated. Too much trouble to redo, to update.
- Long terminal outputs in the docx are really helpful sometimes. Word has the great navigation pane, which you can use to "scroll" past a big text section.
ziptieai.com. Just a simple blog for now. Uses a modified Jekyll theme hosted on Github pages.
ziptieai.org. For now just a barebones Jekyll setup (chapters 1 and 10 only from https://jekyllrb.com/docs/step-by-step/01-setup/) with Ruby on Windows.
Auxdrone Gitbook (old version, basically mirror of wiki)
docs.ziptieai.com (ReadTheDocs/Sphinx) is available (just a few pages of this wiki are there)
(see https://squidfunk.github.io/mkdocs-material/getting-started/)
Docusaurus (tried to run on terrytaylorbiz github 24.0304 ... some unresolved problem... this is just localhost)
Git (future: Add Persson)
Mostly AI examples. For now drone code code segments are short, nothing fancy, just put in the word docs.
https://github.com/squidfunk/mkdocs-material/discussions/3909
https://github.com/blueswen/mkdocs-swagger-ui-tag
https://blueswen.github.io/mkdocs-swagger-ui-tag/pet-store/#markdown
https://docs.scarf.sh/api-v2/ (screenshot below is copied from that URL)
2024.0705 Wiki, Gdrive, Youtube, ZiptieAI.com, ZiptieAI docs. The author is looking for a job!
- Why (you need) ZiptieAI
- Why (I created) ZiptieAI
- Wiki organization (6 epics)
- Blog (updated almost daily)
(0) Reference
EPIC 1 - Build/fly FPV drone
(1) FPV simulators (inav notes 0608)
- 2.0 Technical overviews
- 2.1 MVP (min viable platform)
- 2.2 GPS
- 2.3 Video
- 2.4 Carbon frame
- 2.5 Missions
- 2.6 Tuning (new)
- 2.7 Post-crash rebuild 24.0620
(3) SBeeF405/BF (1b)
(4) SBeeF405/AP (1c)
EPIC 2 - Build/fly Pixhawk drone
(5) Pix6c/PX4 (2a)
(6) Pix6c/AP (2b)
EPIC 3 - Add AI to Pixhawk drone
(7) AI cc + cam
(8a) AI Nano PX4
(8b) AI Nano AP
(8c) AI PI PX4
(8d) AI PI AP
EPIC 4 – Advanced AI
- 9.0 SIH NANO/PX4 24.0703 (WORKS!)
(11) FC FW Mavlink API (via CC/GCS APIs) (5.3)
EPIC 5 – Advanced platforms
(14) Firmware dev (5)
(16) Special projects (5.6,5.5)
EPIC 6 – PITS (Pie in the sky)
(10) (skip) SITL (total sim) (1) (was E4)
- 10.1 SITL AP Core (SITL, Gaz, ROS)
- 10.2 SITL AP C++ mission as ROS node
- 10.3 SITL AP AI Yolo obj recog
- 10.4 SITL AP Lidar obj avoid
- 10.5 SITL AP Drone swarm
- 10.6 SITL AP Flight planners
- 10.7 SITL PX4 Core (SITL, Gaz, ROS)
(14b) Matlab (was E5/4(HITL))
(12) ROS (+ROSMAV) (was E4)