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

Sidenav upgrade #238

Open
souperneon opened this issue Dec 15, 2016 · 6 comments
Open

Sidenav upgrade #238

souperneon opened this issue Dec 15, 2016 · 6 comments
Assignees

Comments

@souperneon
Copy link
Member

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

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

Current behavior:

  • Sub-sections are collapsed and are separate pages
  • Only one sub-section that is currently active can be open at any given moment

Desired (new) behavior:

  • Sub-sections are open on page load
  • Sub-sections are one long page instead of multiple pages
    H1 - Get Started (main sections)
    H2 - Tangram Basics (page names)
    H3 - OpenGL (main sections in a page)
    H4-6 - smaller sections in a page (collapsed, but expandable)
@kkowalsky
Copy link
Member

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
Copy link
Member

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
Copy link
Contributor

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
Copy link
Member Author

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
Copy link
Member

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
Copy link
Member

See also tangrams/tangram-docs#206

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

No branches or pull requests

6 participants