mapzen / documentation

Configuration files, tools, and content to build Mapzen's documentation
https://mapzen.com/documentation
MIT License
25 stars 22 forks source link

Sidenav upgrade #238

Open souperneon opened 7 years ago

souperneon commented 7 years ago

Also in: https://mapzen.com/common/styleguide/js-components.html#side-navigation

screen shot 2016-12-15 at 5 46 28 pm

Current behavior:

Desired (new) behavior:

kkowalsky commented 7 years ago

This index.md has the right heading levels.

If you look at the config YML for tangram you'll see that some of the hierarchy can be built in MKDocs, but the index.md doesn't play nice and wants to always be the first part of the TOC (I think)

kkowalsky commented 7 years ago

anything you want to test for the new nav should use the src-tangram-new (Still WIP) folder: https://github.com/mapzen/mapzen-docs-generator/tree/katie/tangram-update

migurski commented 7 years ago

I would split this from the new Tangram work. It's a separate thing that we want apply throughout, and mixing it up with the other new stuff will make it harder to roll out.

souperneon commented 7 years ago

I agree. I was using the Tangram wireframe to illustrate the type hierarchy and explain how the logic should work with the left nav. Once we have a version of it built, testing it with Tangram docs will be good :)

hanbyul-here commented 7 years ago

Leaving a note for future: I spent times with docs-generator, and found out it doesn't know about headers outside of current page context. Page structure from config file is saved as nav, accessible from theme, but headers are not saved as globla object like nav, it is saved in page scope which is only accessible from current page.

rmglennon commented 7 years ago

See also https://github.com/tangrams/tangram-docs/issues/206