Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Pages should begin with introductory paragraph(s) without any <h2> level header. Subsequent sections should begin with <h2> headers.
    • The page title, specified in the metadata of the Markdown file, will be converted to an <h1> header ahead of the introductory content.
  • Any text that will be consistent across a number of pages (e.g. production status notes or deprecation warnings) should NOT be hard-coded into the Markdown. Instead, use metadata that will be processed by Docpad, to ensure consistent wordings.
    • The specific mechanism for this will be determined when it needs to be implemented.
  • "Notes" should be wrapped in <div> elements with a specific class to be used for styling the infusion-docs-note class and begin with "Note:"; This will ensure that the note is styled according to the designs. The class name is yet to be determined.

Questions

  1. Should text in a header be styled as code? It makes detecting a header a little bit difficult.
  2. Should this style guide live inside the github repository with the source files, or here in the Fluid wiki space?