Upgrade to PRO for Only $50/Year—Limited-Time Offer! 🔥

Single Page Docs

Avatar for Brandon Philips Brandon Philips
April 09, 2013
1
110

Single Page Docs

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

Avatar for Brandon Philips

Brandon Philips

April 09, 2013
Tweet

More Decks by Brandon Philips

See All by Brandon Philips
Node.js Workflow with Minikube and Skaffold
Avatar for Brandon Philips philips
0
270
Manage the App on Kubernetes
Avatar for Brandon Philips philips
0
340
Production Backbone Monitoring Containerized Apps
Avatar for Brandon Philips philips
0
200
KubeCon EU 2017: Dancing on the Edge of a Volcano
Avatar for Brandon Philips philips
1
780
rkt - KubeCon EU keynote - 2017
Avatar for Brandon Philips philips
1
280
FOSDEM_Keynote_2017-_.pdf
Avatar for Brandon Philips philips
0
140
Tectonic Summit Day 2 Keynote
Avatar for Brandon Philips philips
0
370
Kubernetes: Simple to Manage Anywhere (self-hosted, Tectonic upgrade demo)
Avatar for Brandon Philips philips
0
410
KubeCon Keynote 2016- Distributed Systems Simplified on Kubernetes
Avatar for Brandon Philips philips
2
570

Featured

See All Featured
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
Avatar for Kevin Liebholz kevinliebholz
36
6.2k
How GitHub (no longer) Works
Avatar for Zach Holman holman
316
140k
4 Signs Your Business is Dying
Avatar for Josh Pigford shpigford
186
22k
The Art of Delivering Value - GDevCon NA Keynote
Avatar for David Neal reverentgeek
16
1.8k
[RailsConf 2023 Opening Keynote] The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
31
9.8k
Stop Working from a Prison Cell
Avatar for Chris Michel hatefulcrawdad
273
21k
GitHub's CSS Performance
Avatar for Jon Rohan jonrohan
1032
470k
Documentation Writing (for coders)
Avatar for Carmen Chung carmenintech
76
5.2k
Producing Creativity
Avatar for Steve Smith orderedlist
PRO
348
40k
A better future with KSS
Avatar for Kyle Neath kneath
240
18k
Automating Front-end Workflow
Avatar for Addy Osmani addyosmani
1371
200k
YesSQL, Process and Tooling at Scale
Avatar for Rocio Delgado rocio
174
15k

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