If It’s Not Documented, Your Project Doesn’t Exist
summary
Argues that lack of documentation hides otherwise great projects and prescribes four concrete docs types: tutorials, how‑to guides, API reference, and architecture explanations. Recommends keeping docs alongside code in plain text under version control using reStructuredText or Markdown, generating sites with Sphinx or MkDocs and publishing on Read the Docs or GitHub Pages, and gives practical reasons (adoption, contributions, future memory) plus workable workflow practices.
AI-written summary · about
chapters (6)
related talks
01h 06mDocument your code
23mMkDocs: Documenting projects with Markdown
31mIncorporating Managed Information Repositories to Generate On-Demand Documentation
02h 28mWriting Documentation with Sphinx and reStructuredText
02h 59mDocumenting your code from docstrings to automated builds
18mThanks, I Made It with Quartodoc
30mMaking Your Documentation Interactive with PyScript
22mStatic Sites with Sphinx and Markdown