Skip to content

Consolidate Documentation

Background

The documentation for this repo has not been sufficiently updated to reflect recent changes from the previous development sprints. Additionally, the documentation is large incomplete or scattered; requiring new developers to piece together information from multiple sources to understand how execute the builder repository. Incomplete list of documentation includes.

  • Main README.md for builder - some additional environment setup information
  • PLUGINS.md - provides context for how to setup environment and incomplete explanation for nox works
  • Docker specific README.md - instructions how to run containers with docker, though only partially correct.
  • SERVER.md - some server information, but also explains some of the compose.yml/docker-compose.yml settings?

Closure Criteria

  1. The documentation for this repository has been updated to reflect current set up, build, run and procedures.
  2. The documentation is sufficiently crosslinked (or consolidated) such that relevant information can be located from main README.md file for the repository.