Open samccone opened 9 years ago
I think documentation needs its own landing/embedded page, that quickly guides users between different docs topic. Angular has one:
https://github.com/angular/angular.js/blob/master/docs/content/guide/index.ngdoc https://docs.angularjs.org/guide
In case of polymer one could read entire basic knowladge from the landing page embedded into context of docs (just like in angular): https://github.com/Polymer/docs/blob/master/docs/polymer/polymer.md https://www.polymer-project.org/docs/polymer/polymer.html
Marionette and Ember docs tend to be more documentation like without letting read something on the start (and people are lazy): http://marionettejs.com/docs/current/ http://emberjs.com/api/ (but Ember has guides section).
I'm lazy and I also like to read something on the very first page:
I agree with the need to a specific landing page for the doc. A tree rows/colums layout with an introduction for each is a good start.
The view section will be big, maybe it will need to be split in two part : basic view and advanced view.
Since our current doc page has a table of contents people seem to think the correct place to start is at the top (and I don't blame them)
When the reality is the Application object is a pretty weak way to start off understanding how marionette works.
I propose we rethink how this page is done to give people a better idea of how to dive in.
Perhaps a three column system