A kernel documentation update
summary
Architecture docs move into Documentation/arch/ and about 30–40 device docs are slated to move next, reducing ~100 top-level entries; Rust docs are integrated into the Sphinx system; docs.kernels.org serves roughly 150,000 requests per day with the coding-style page getting ~8,000 daily hits. Sphinx upgrades cause Sphinx build time doubles (1.7 → 3.x issues), an attempted warnings-on build produces ~1,000 warnings, and there are no paid doc maintainers, so tooling fixes, partial builds, man output and sidebar redesign are proposed but not yet funded.
AI-written summary · about
chapters (14)
- 0:00Introduction and goals
- 1:27Architecture docs reorganization
- 3:40Future documentation plans
- 6:07Text vs HTML documentation
- 17:44Documentation audience and scope
- 23:08Documentation source location
- 26:42Markdown vs reStructuredText
- 29:10Documentation build speed
- 34:50Sidebar and navigation design
- 39:08Process documentation focus
- 43:47Support for documentation work
- 47:22Maintainer responsibility for docs
- 50:02Contributing to documentation
- 56:45Enforcing documentation requirements
related talks
41mKernel documentation: update and future directions
41mWhat kernel documentation could be
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
29mContinuous Documentation: basics and advanced techniques
31mAutomating Linux Kernel Documentation for Safety-Criti...
59mTransforming your Documentation Process
25mDoctopus: How Ceph Documentation is Maintained & Evolved, & How You Can Contribute
26mEvolution of Product Documentation