Skip to content

Latest commit

 

History

History
14 lines (11 loc) · 755 Bytes

documentation_guidelines.md

File metadata and controls

14 lines (11 loc) · 755 Bytes

Documentation Guidelines

  • ⚠️Keep it organized and structured⚠️

  • For new features, create new documentation and place it in the appropriate folder(s)
    • If the feature adds new functionality, it should be added to the feature section of the main Readme
  • When you create a new document, do not forget to add it to the table of content
  • Add a shortcut that point back to the README.MD in the bottom of new documents (look at other docs for example)
  • Use # / ## / ### for the different section of the doc
  • Do not add unrelated information to an existing document, create a new one if needed
  • For incremental updates, you need to update the main README.MD