Documentation

[brynolv]

Documentation Guidelines

A Repository is considered documented if it meets the following requirement:

• it has an API specification for all its endpoints
• it has a segment specifying ENV variables required
• it has a complete list of dependencies specifying which other systems it uses/relies on
• it has a complete set of instructions for how to launch the system in a production environment
• it has a complete set of instructions for how to launch the system in a development environment
• it has a description of all Pls permissions it uses and how they affect the application