Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Single Page Docs

Brandon Philips
April 09, 2013
1
100

Single Page Docs

Talk given at http://conf.writethedocs.org/

Brandon Philips

April 09, 2013
Tweet

More Decks by Brandon Philips

See All by Brandon Philips
Node.js Workflow with Minikube and Skaffold
philips
0
230
Manage the App on Kubernetes
philips
0
310
Production Backbone Monitoring Containerized Apps
philips
0
130
KubeCon EU 2017: Dancing on the Edge of a Volcano
philips
1
640
rkt - KubeCon EU keynote - 2017
philips
1
240
FOSDEM_Keynote_2017-_.pdf
philips
0
97
Tectonic Summit Day 2 Keynote
philips
0
310
Kubernetes: Simple to Manage Anywhere (self-hosted, Tectonic upgrade demo)
philips
0
320
KubeCon Keynote 2016- Distributed Systems Simplified on Kubernetes
philips
2
530

Featured

See All Featured
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
233
17k
Automating Front-end Workflow
addyosmani
1368
200k
Unsuck your backbone
ammeep
669
57k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
133
33k
Side Projects
sachag
452
42k
Building Adaptive Systems
keathley
40
2.4k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
280
13k
Building Flexible Design Systems
yeseniaperezcruz
328
38k
We Have a Design System, Now What?
morganepeng
51
7.4k
Agile that works and the tools we love
rasmusluckow
328
21k
VelocityConf: Rendering Performance Case Studies
addyosmani
328
24k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
21
2.5k

Transcript

  1. Single Page Docs @BrandonPhilips [email protected] Monday, April 8, 13

  2. Monday, April 8, 13

  3. Doc Anti-Patterns Monday, April 8, 13

  4. Monday, April 8, 13

  5. Monday, April 8, 13

  6. Single Page Patterns Monday, April 8, 13

  7. Monday, April 8, 13

  8. • Single Page Monday, April 8, 13

  9. • Single Page • Persistent Navigation Monday, April 8, 13

  10. • Single Page • Persistent Navigation • Dynamic Orientation Monday,

    April 8, 13

  11. Single Page Monday, April 8, 13

  12. Monday, April 8, 13

  13. Monday, April 8, 13

  14. • Scrolling is natural Monday, April 8, 13

  15. • Scrolling is natural • Search is free in browsers

    Monday, April 8, 13

  16. Monday, April 8, 13

  17. • Forces beginning, middle and end thinking Monday, April 8,

    13

  18. • Forces beginning, middle and end thinking • Fewer and

    simpler editor windows Monday, April 8, 13

  19. Persistent Navigation Monday, April 8, 13

  20. Monday, April 8, 13

  21. Monday, April 8, 13

  22. • Reduces frustration of skipping ahead Monday, April 8, 13

  23. • Reduces frustration of skipping ahead • Feels natural to

    quickly find TOC Monday, April 8, 13

  24. Monday, April 8, 13

  25. • Constantly reminded of section bloat Monday, April 8, 13

  26. • Constantly reminded of section bloat • Reduce length of

    section names Monday, April 8, 13

  27. Dynamic Orientation Monday, April 8, 13

  28. Monday, April 8, 13

  29. Monday, April 8, 13

  30. • How much more? Monday, April 8, 13

  31. • How much more? • What did I read? Monday,

    April 8, 13

  32. • How much more? • What did I read? •

    Should I skip ahead? Monday, April 8, 13

  33. Terminology Monday, April 8, 13

  34. Fixie Docs Monday, April 8, 13

  35. Building a Fixie Monday, April 8, 13

  36. Know the Downsides Monday, April 8, 13

  37. The Right Match Monday, April 8, 13

  38. Monday, April 8, 13

  39. Splitting the Docs Monday, April 8, 13

  40. Monday, April 8, 13

  41. Tools Monday, April 8, 13

  42. What about size? Monday, April 8, 13

  43. 0 750 1500 2250 3000 Uncompressed Compressed Full Express API

    Neil deGrasse Tyson Monday, April 8, 13

  44. A Product* Monday, April 8, 13

  45. Monday, April 8, 13

  46. github.com/philips/fixiedocs Monday, April 8, 13

  47. Thanks! @BrandonPhilips http://ifup.org Monday, April 8, 13