Panel Discussion - Documentation Why , When, How, and React?
summary
Practical, concrete advice: run interactive API requests inside docs, propagate chosen code language site‑wide, and add an “I don’t understand this” button that opens a GitHub issue. Use tools like OpenAPI/Swagger or JSDoc to generate API pages, or Rust‑style auto-doc close to code. Measure users with ~10 targeted interviews and on‑site surveys (they found ~40% of React Native docs readers lack JS background). Start docs‑first with templates, enforce versioned docs, and accept community translations (Astro has 14 languages, Spanish 100% translated).
AI-written summary · about
chapters (10)
- 0:00Introduction to panel
- 3:13Meet the panel experts
- 4:39What makes good docs
- 12:50Architecting documentation
- 18:47Tips for inclusive docs
- 26:40Contributing to docs
- 31:54Impact of documentation
- 32:35Audience questions
- 41:54Legacy app documentation
- 43:22Final thoughts and wrap-up
related talks
35mGateway to React: the react.dev story
13mGateway to React: the react.dev story
42mDocumentation in legacy React code - A love/hate paradigm
43mPanel Discussion
23m12 Tips For More Accessible React Apps
27mA Practical Guide to Building Your Design System Infrastructure
50mTips, tricks and tools for building accessible React web apps
11mInclusive React: A Survival Guide