Skip to content

Latest commit

 

History

History
9 lines (7 loc) · 547 Bytes

how-to-create-a-doc-file.md

File metadata and controls

9 lines (7 loc) · 547 Bytes

META: How to create a new documentation file

Documentation conventions

  • Find the correct subdirectory your new documentation file belongs to.
  • Every documentation file should be markdown (with .md extension).
  • First line of every documentation file should contain its title (used to generated the table of content).
  • Store all the images in an /images subfolder in the same directory the document referencing them will be.
  • Table of content (TOC) is generated automatically with every commit, all changes will be staged accordingly.