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
320
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
98
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
How to Ace a Technical Interview
jacobian
276
23k
Adopting Sorbet at Scale
ufuk
74
9.2k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
6
570
The Cult of Friendly URLs
andyhume
78
6.2k
Making the Leap to Tech Lead
cromwellryan
133
9.1k
Raft: Consensus for Rubyists
vanstee
137
6.8k
KATA
mclloyd
29
14k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
226
22k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
27
1.9k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
30
2.2k
The World Runs on Bad Software
bkeepers
PRO
67
11k
Git: the NoSQL Database
bkeepers
PRO
427
65k

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