ractivejs/v0.x

A more centralized, in-depth documentation

fskreuz opened this issue · 3 comments

fskreuz commented

I like the idea of the docs being structured like a blog. But I have come to the point that searching through the docs isn't one of the greatest experiences.

  • Some pages (learn, 60s setup and example) feel disconnected because of the the different look.
  • It's hard to look for APIs I need. I have to scan through several pages.
  • Plugins are probably outdated/breaking.
  • Ractive works like magic but we don't really know how.

Overhaul I guess? Something like the following:

  • Angular Docs
    • One sidebar for everything
    • A really visible version select
    • Search
    • APIs first
    • Inline live code editor
  • Read The Docs
    • One sidebar for everything
    • Search
  • Backbone, Underscore
    • One sidebar for everything
    • Data flow diagrams
  • jQuery
    • One sidebar for everything
    • Deprecation notices
    • Version added
    • Return types
  • React
    • One sidebar for everything
    • A lot of learning materials

A related issue is #51 which discusses ideas about:

  • Using Ractive in the docs. Who wouldn't want to use their own product on their own sites?
  • Inline live code examples. (A compact version of the learn subsite).
  • Updated build system. Gobble possibly? That way, everything is in-house tech?
Madgvox commented

👍

rstacruz commented

Maybe something like gitbook over at http://redux.js.org/ ? :)