onosproject / onos-docs

Consolidated documentation for the ONOS project.
https://docs.onosproject.org
4 stars 10 forks source link

Enable markdown linter for docs #65

Closed adibrastegarnia closed 4 years ago

adibrastegarnia commented 4 years ago

To make sure we are following a minimum standard for docs in terms of formatting, we should enable markdown linter and also choose a set of its rules that are important.

https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md001---header-levels-should-only-increment-by-one-level-at-a-time