DEV Community

Discussion on: 5 Tips for Writing Good Documentation

Collapse
 
burdettelamar profile image
Burdette Lamar

I've been leaning more and more toward:

Note that right now, markdown_helper can construct a page TOC that you can then include on your own. This week I will be updating the project (and its Ruby gem) so that a page TOC can be generated on the first inclusion pass.

Coming soon will be the project TOC: tree of links to all markdown pages in the project.