Open Sentencing Documentation Updates #56
Description
Background
Open Sentencing has existing documentation on frontend application and backend services. We would like you try out the application and suggested improvements to the documentation.
During this cohort your team members will also be making updates to the Open Sentencing application. We would like to document these new changes in our documentation as well.
repositories:
- https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-UI
- https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator
- https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Model
Tasks
Adding new documentation
- Discuss with Open Sentencing cohort members to understand changes to Open Sentencing application
- Create a new issue using the documentation templates
- label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
- Discuss your changes in the issue
Related Issues:
Fixing existing Documentation
- Check out the open documentation issues
- Read & follow the instructions in the Getting Started section of the readme.md to set the solution up
If any directions are unclear, outdated: - create a new issue using the documentation template
- label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
- Discuss your changes in the issue