marionettejs.com icon indicating copy to clipboard operation
marionettejs.com copied to clipboard

Improve docs toc

Open jammon opened this issue 8 years ago • 2 comments

For the uninitiated the docs site begins rather terse. They can choose any topic and start to read, and it looks as if you had to read everything before you get the big picture. (Later the docs are waaay better!)

I suggest to group the links to the different pages into topics and provide them with an explanation, usually the first paragraph of the referred page. I made an example page for v.2.4.5. I'd like to do a real pull request, but I don't understand, how this page is generated, sorry. marionette.toc.md.txt

jammon avatar Apr 09 '16 11:04 jammon

I think the TOC is generated from an automated grunt task: https://github.com/marionettejs/marionettejs.com/blob/master/gruntfile.js#L33

Correct me if I'm wrong, @samccone.

@jammon: We also have guides here: https://marionette.gitbooks.io/marionette-guides/content/en/

jdaudier avatar Apr 09 '16 17:04 jdaudier

I think I've just been looking at the same thing @jammon. I think the file you're looking for is https://github.com/marionettejs/marionettejs.com/blob/master/src/docs/index.hbs. I'm assuming you're wanting to update the main index page of the documentation?

scott-w avatar Apr 16 '16 12:04 scott-w