search

mapzen / documentation

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

Heading stylings translated from # in markdown are too large #285

Closed rmglennon closed 7 years ago

rmglennon commented 7 years ago

Traditionally, we've used one # for the top heading and ## and ### for additional headings on a markdown page. With recent style guide updates, this looks too large on the page. Perhaps we take # down to H2 or maybe even H3 and so on.

This came up in comments in https://github.com/mapzen/documentation/pull/283. Adding here because it's an issue across all docs.

image

rmglennon commented 7 years ago

@rfriberg noted that the documentation pages have two <h1> tags on them, one for the text in the top banner and one for the first heading on the page. This can cause some search engine optimization issues.

"An ideal H1 will be specific and relevant to the page. What we could do is make the banner text a different heading tag and make the first (actual) heading on the page an H1 (shrunk down a bit if that's what's desired)."

rfriberg commented 7 years ago

@rmglennon - I'm trying to assign this to @meghanhade . Does she need to be added to some user list on this repo?

meghanhade commented 7 years ago

👋 I'm here to help

rmglennon commented 7 years ago

see https://precog.mapzen.com/mapzen/documentation/meghan-heading-styling/documentation/overview/ for a preview

meghanhade commented 7 years ago

The styleguide changes are in this PR: https://github.com/mapzen/styleguide/pull/477

rfriberg commented 7 years ago

Preview looks good. My only concern is that we now have the same font size (24px) for both h2 and h3 (except on mobile).

meghanhade commented 7 years ago

@rfriberg I'll fix that.

meghanhade commented 7 years ago

@rfriberg @rmglennon I bumped the h3 font-size down and added in the padding-top for the documentation-header as well. These changes are on the meghan-heading-styling branch.

rfriberg commented 7 years ago

Looks good to me. Thanks!

rmglennon commented 7 years ago

Thanks @meghanhade. pull request when you are ready!

meghanhade commented 7 years ago

@rmglennon @rfriberg Final step--now that this styling has been merged in on the styleguide, I've removed the hard-coded css from the documentation file. If you could take one last look and approve, I'll merge.

rmglennon commented 7 years ago

fixed over in https://github.com/mapzen/styleguide/pull/477