Skip to content

2.2.6 Split the README

Related to the audit.

This README document should be split in at least 3 parts:

  • Back-end and database setup and development (including a link to the latest API documentation).
  • Front-end setup, development and conventions.
  • Application deployment.

Each part will be stored in a dedicated file, and a table of content will be added the main README.

Note that such effort was started by a contributor in a merge request, which could be used as a base for implementing this recommendation.

The referenced merge request is stale but may be merged as a starting point.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information