How to open source a PHP package
summary
Walks through a practical PHP Package Checklist with concrete steps: Composer and PSR‑4 autoloading setup, semantic versioning and changelog practices (keepachangelog.com), writing unit tests and wiring a continuous integration workflow, and a live example using Glide to show results and Google Analytics traffic. Covers documentation structure — pitch, example, guides, reference — and tooling choices like Jekyll + GitHub Pages, syntax highlighters (Rouge or Prism.js) and DocSearch for site search, with implementation tips that actually work.
AI-written summary · about
chapters (46)
- 0:00Introduction
- 0:39PHP League
- 1:09Documentation
- 1:54Teaching
- 2:46Consuming documentation
- 3:21Good documentation
- 3:34Myths on documentation
- 3:45Myth 1 Read the code
- 4:29Myth 2 Autogenerated API docs
- 5:49Myth 3 Readme
- 6:13Myth 4 Documentation
- 6:39Myth 5 Documentation
- 7:05Incremental II
- 7:29Why Documentation
- 8:57What makes good documentation
- 9:17The Pitch
- 9:32Elevator Speech
- 9:57Why it matters
- 10:32Bonus points
- 10:59Not acceptable
- 11:38Licenses
- 12:48Minimum viable example
- 13:25Guitar lesson example
- 14:34Google Analytics
- 14:58screencasts
- 15:32guides
- 17:21table of contents
- 18:08subtitles
- 18:38examples
- 18:59reference
- 19:25changelog
- 19:40notes
- 20:09change log
- 20:48GitHub pages
- 21:36API docs
- 22:06Welcome contributions
- 22:49Documentation layout
- 24:49Design matters
- 25:43Fonts
- 26:15Colors
- 26:58Content
- 27:31Syntax Highlighting
- 28:57Search
- 30:28Document Correction
- 31:12Install Google Analytics
- 31:42One last thought
