ScubaGear icon indicating copy to clipboard operation
ScubaGear copied to clipboard

Add configuration file references to Getting Started documentation

Open schrolla opened this issue 1 year ago • 0 comments

Prerequisites

  • [x] This issue has an informative and human-readable title.

💡 Summary

Add the following items to the Getting Started section of the ScubaGear README. The update should point users to where to get more information on using configuration files and how agencies can include required information for reporting purposes.

Motivation and context

Several reports from users indicate that the current README is insufficient or does not highlight early enough that a configuration file is available, when users might need it, or that a config file is necessary for some agency reporting scenarios. Moving references to the configuration file documentation into the Getting Started section helps highlight these options to new users without having to dig deeply into the documentation pages.

Implementation notes

  1. Note the documentation sections that would be useful to highlight, such as the SCuBA Compliance example and the more general configuration section.
  2. Update the Getting Started section to include these references

Acceptance criteria

  • Getting Started section of README has been successfully updated to include reference to the configuration file documentation
  • Getting Started section of README has been successfully update to include information for agencies to report org info via config file

schrolla avatar Mar 19 '25 19:03 schrolla