Navigating DocC
summary
DocC is a documentation compiler that hooks into the Swift compiler to auto generate docs and warnings, supports double backticks for symbol linking with autocomplete, and emits warnings for broken links but cannot link outside the current module or document public extensions of external types. It exports a .doccarchive of minified JSON consumed by a Vue web viewer, and community tools like serve_docc and docc-to-html let you serve locally or produce static HTML. Tutorials use markdown directives.
AI-written summary · about
chapters (9)
- 0:00Introduction to DocC
- 3:03Generating basic documentation
- 6:57Limitations of DocC
- 9:01Exporting and deploying docs
- 13:11Documentation catalog basics
- 17:41Adding articles and extensions
- 19:06Creating tutorials
- 23:19Summary and feedback
- 24:22Q&A session
related talks
24mEscaping the Curse of Outdated Docs
51mDocumentation as Code (Explained to My Father)
16mcod == doc
25mDocumentation as Code, Where to Start?
43mcljdoc
28mCode the Docs: Interactive Document Environments
35mThe practical implementation of Documentation as Code
50mContinuous and Automated Documentation Docs As Code in Practice