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

Check All Headers In Documentation #30

Closed
GeeH opened this issue Oct 30, 2015 · 3 comments
Closed

Check All Headers In Documentation #30

GeeH opened this issue Oct 30, 2015 · 3 comments

Comments

@GeeH
Copy link
Contributor

GeeH commented Oct 30, 2015

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.

@froschdesign
Copy link
Member

@GeeH
The docs folder is missing in this repository!

@weierophinney
Copy link
Member

@froschdesign Not any longer. :)

@froschdesign
Copy link
Member

@weierophinney
Thanks! 👍

@weierophinney weierophinney self-assigned this Feb 11, 2016
weierophinney added a commit to weierophinney/zend-cache that referenced this issue Feb 11, 2016
- Checked all headers (fixes zendframework#30)
- Checked all tables (fixes zendframework#33)
- Checked all blockquotes (fixes zendframework#34)
- Checked for content and examples (fixes zendframework#32)

This patch also converts to mkdocs, and reorganizes the structure slightly.
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

3 participants