Running Amok: Igniting a Documentation Revolution
summary
Claims a documentation revolution and gives a concrete toolchain: Amok plus integration with Fury that indexes and aggregates documentation stored by commit so old docs can be mutated and fixed. It presents a working proof‑of‑concept database layer, a linker and presentation layer and a CLI, demonstrates storing metadata and tests as files store metadata by commit hash, and shows how builds get exact, versioned snapshots and lower the barrier for doc contributions.
AI-written summary · about
chapters (41)
- 0:00Introduction
- 1:33Why this idea came about
- 2:12Scenario 1 Dependencies
- 3:23Scenario 2 Dependencies
- 4:18Scenario 3 Notification
- 5:06Scenario 4 Release
- 6:02Immutable Documentation
- 7:35What is Documentation
- 8:05Documentation Examples
- 8:24Documentation Details
- 8:53The Problem
- 11:32My Goal
- 11:52A Mock
- 13:06Architecture
- 14:06Metadata
- 14:54Examples
- 16:03File system
- 18:20Example metadata
- 20:31Universal namespace
- 20:41Dependencies
- 21:29Packages
- 22:02Applications
- 23:33Bench
- 24:10Tests
- 26:05Implementation
- 28:53Commit hashes
- 29:22Git rewrite hook
- 30:17Multiple branches
- 31:19Presentation
- 33:42Fury
- 36:21Amok Repository
- 39:23Recap
- 39:42Whats Relevant
- 42:54Documentation
- 43:26Whats next
- 44:15Document Fury
- 44:57Questions
- 47:42Scala Compiler
- 48:31scoping in sprints
- 49:07convincing a PO2
- 51:58lowlevel tool
related talks
56mEffective Documentation: The Key to Open Source Growth
45mDocs That Scale: Strategies for Sustainable Documentation in Open Source Projects
05mMy Open Source Docs Addiction
35mThe Art of Documentation and Readme.md for Open Source Projects
40mDocs Tools for OSS Maintainers
39mOpen Docs, Open Collaboration: Building Better Documentation with Community PRs
19mThe community wrote my docs!
43mFOSS DOCS 101 (keep it simple, present!)