~/talk

Not just witty comments in your code: Documentation best practices for themes, plugi...

Talkat WordCamp Hamilton 2019 · on Saturday, 2019-06-01· [documentation]
links:none on file
slides:none on file

Argues that documentation must be actionable: use phpDocumentor to generate static HTML from docblocks, use Swagger/Apiary plus JSON examples for REST endpoints and list expected error responses, and use Postman to validate generated snippets. Recommends minimum docblocks for classes and methods, chunked CSS or Sass sections, step‑by‑step user guides with screenshots, and a support/knowledge base (BBPress or Zendesk). Claims comments speed onboarding and suggests erring on slightly more detail rather than less.

AI-written summary · about

~/search
type to search 6,518 conferences, 143,918 speakers and 192,133 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
← →
on a talk: 5 seconds back / forward
0–9
on a talk: jump to 0%–90% of the recording
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.