Versions Compared

Key

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

...

Each of the sub-dirs should also have an “index.md” file to organize their content.

Files and sections

A section subsection of your documentation should be contained entirely in a single file. Short sections can be grouped in to one file.

Equation numbering ( and references to equations ) will only work within a are local to an individual markdown file.

Figures

When you start adding figures to your documentation, keep in mind that binary files can lead to repo size bloat IF they change a lot so don’t commit a figure to the repo until you are confident its the near-final version.

...