Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs toc #446

Open
jammon opened this issue Apr 9, 2016 · 2 comments
Open

Improve docs toc #446

jammon opened this issue Apr 9, 2016 · 2 comments

Comments

@jammon
Copy link

jammon commented Apr 9, 2016

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

@jdaudier
Copy link
Contributor

jdaudier commented Apr 9, 2016

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/

@scott-w
Copy link
Member

scott-w commented Apr 16, 2016

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants