Skip to content
This repository has been archived by the owner on Apr 28, 2020. It is now read-only.

Check All Headers In Documentation #6

Closed
GeeH opened this issue Jan 20, 2016 · 0 comments
Closed

Check All Headers In Documentation #6

GeeH opened this issue Jan 20, 2016 · 0 comments

Comments

@GeeH
Copy link
Contributor

GeeH commented Jan 20, 2016

Check headers are correct

TLDR; Headers should use the #, ## etc to format different levels of headers, and not be underlines using ===== or ``-----`, or be psuedo header using bold

Check all headers on the documentation - headers should use the hash style of declaration rather then be underlined with equals or dashes. The more hashes, the more of a subheading. Eg:

  • # is equal to <h1>
  • ## is equal to <h2>
  • ### is equal to <h3>
  • #### is equal to <h4>
  • ##### is equal to <h5>

Headings should be appropriate for their level in the documentation.

Psuedo headers using bold tags ** should be replaced with appropriate level of heading tag.

weierophinney added a commit that referenced this issue Apr 21, 2016
[Docs] - Fixes #6 - Check All Headers In Documentation
weierophinney added a commit that referenced this issue Apr 21, 2016
Close #11
Close #12
Close #13
Close #14
Close #15
Close #16
Fixes #6
Fixes #7
Fixes #8
Fixes #9
Fixes #10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant