Versions Compared

Key

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

...

  • Where our documentation needs to fit in the overall documentation structure, as well as
  • The structure of our documents.
    • Chapters
    • .rst files
      • start with assuming one chapter per .rst file
      • if chapters too big then chunk smaller by document sections
      • objective is to keep manage-ably sized, coherent chunks of content together for review/commit purposes  
    • The structure of our documents should be reflected as within the repo structure of our project.
      •  directoriesdirectories
        • all the .rst files of one document in one directory
        • only one document per directory