Skip to content

Style Guide

homotechsual requested to merge github/fork/seancolsen/content-standards into master

Created by: seancolsen

For the Dev Guide, we've had some discussion recently about things like page titles and navigation structure. In an effort to shore up these decisions and provide clarity for future documentation editors, I thought it would be good to have a "Content Standards" section in the Documentation page, which I've proposed in this PR. As I see it, these content standards would apply to all guides (current and future). The User Guide, as it stands, is pretty well in compliance with these proposed standards.

Seeking go-ahead from @totten @michaelmcandrew @nganivet and @joannechester before merging.

For clarification:

  • "Markdown standards" specify how to choose between several markdown syntax options that all produce the same HTML
  • "Content standards" specify how to write things that actually produce different results to the human reader of the documentation

This issue is about content standards not markdown standards.

Merge request reports