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

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
240
Manage the App on Kubernetes
Avatar for Brandon Philips philips
0
320
Production Backbone Monitoring Containerized Apps
Avatar for Brandon Philips philips
0
140
KubeCon EU 2017: Dancing on the Edge of a Volcano
Avatar for Brandon Philips philips
1
660
rkt - KubeCon EU keynote - 2017
Avatar for Brandon Philips philips
1
240
FOSDEM_Keynote_2017-_.pdf
Avatar for Brandon Philips philips
0
110
Tectonic Summit Day 2 Keynote
Avatar for Brandon Philips philips
0
320
Kubernetes: Simple to Manage Anywhere (self-hosted, Tectonic upgrade demo)
Avatar for Brandon Philips philips
0
340
KubeCon Keynote 2016- Distributed Systems Simplified on Kubernetes
Avatar for Brandon Philips philips
2
540

Featured

See All Featured
Code Reviewing Like a Champion
Avatar for maltzj maltzj
523
40k
Performance Is Good for Brains [We Love Speed 2024]
Avatar for Tammy Everts tammyeverts
10
840
The Art of Delivering Value - GDevCon NA Keynote
Avatar for David Neal reverentgeek
14
1.5k
[RailsConf 2023 Opening Keynote] The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
29
9.5k
Git: the NoSQL Database
Avatar for Brandon Keepers bkeepers
PRO
430
65k
Practical Tips for Bootstrapping Information Extraction Pipelines
Avatar for Matthew Honnibal honnibal
PRO
19
1.2k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
Avatar for Eileen M. Uchitelle eileencodes
34
2.3k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
Avatar for Dan Newman danielanewman
228
22k
Navigating Team Friction
Avatar for Lara Hogan lara
186
15k
Documentation Writing (for coders)
Avatar for Carmen Chung carmenintech
71
4.8k
[RailsConf 2023] Rails as a piece of cake
Avatar for Vladimir Dementyev palkan
55
5.6k
Improving Core Web Vitals using Speculation Rules API
Avatar for Sergey Chernyshev sergeychernyshev
15
890

Transcript

  1. Single Page Docs @BrandonPhilips brandon@ifup.org 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