Automatic Documentation

Automatic documentation tools such as DFPy, autodoc, doc-comments-ai, and AutoDoc-ChatGPT streamline code organization and comprehension by generating markdown documents from text summaries. MkDocs and hnswlib are highlighted as beneficial frameworks and libraries.

---

DFPy, auto example based prompt engineering

---

Semantic search, question-answer generation (query generation), prompt engineering, template generation, usage generation, topic/category clustering, turn plain text summaries into markdown document.

Bad written code will suffer from longer process time (1000+ loc file), ambiguous project structure and so on. Currently the file cache system is just enough.

Related things:

autodoc with self-generated documentation

doc-comments-ai

AutoDoc-ChatGPT

write-the

Cody codebase understanding

symf (without readme, closed source?)

sourcegraph (remember how we browse source code of bilibili and potentially gta5 code)

livegrep

issue on rg to create persistant index

Documentation frameworks:

mkdocs

Useful libraries:

hnswlib