Decide on Standard Repo Documentation

[JasonDCox]

Description

Research and look into different types of documentation and styles for repository documentation.

Acceptance Criteria

• Be ready to discuss ideas at our Monday meeting
• Have examples ready to present at Monday meeting

Examples

• https://github.com/gavinjalberghini/NNSB-CCIPT
• https://github.com/contentful/the-example-app.py

[gavinjalberghini]

Please post your findings on this thread.

[brandonC1234]

I much more prefer the first example where we separate the project by sections like code and data and have a readme describe each segment.

[JasonDCox]

I agree with Brandon

[JasonDCox]

Agreement made at meeting to follow the Newport News Climate Change Repository as a template for this Repo.