Documentation - terrytaylorbonn/auxdrone GitHub Wiki

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:

  1. Main docs
  2. ziptieai.com/org
  3. Gitbook
  4. Code/API docs
  5. Code/API sources (Git, Postman and Swagger)

1. Main docs

This wiki

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.

Google drive

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.

image

2. ziptieai.com/org

ziptieai.com. Just a simple blog for now. Uses a modified Jekyll theme hosted on Github pages.

image

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.

image

3. Gitbook

Auxdrone Gitbook (old version, basically mirror of wiki)

image

Demo API documentation

image

4. Code/API docs (just skeleton docs for now)

docs.ziptieai.com (ReadTheDocs/Sphinx) is available (just a few pages of this wiki are there)

image

Mkdocs example githubpages (xxx)

(see https://squidfunk.github.io/mkdocs-material/getting-started/)

image

Docusaurus (tried to run on terrytaylorbiz github 24.0304 ... some unresolved problem... this is just localhost)

image

5. Code/API sources (Git, Postman and Swagger)

Git (future: Add Persson)

Mostly AI examples. For now drone code code segments are short, nothing fancy, just put in the word docs.

image

Postman (future)

Swagger (future)

notes ===============================

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)

image