Assess the CIIP repo's documentation.
Things to consider:
- What is outdated
- What is missing
- Is it organised in a way that makes sense and is discoverable
Todo:
- Remove or update outdated documentation
- Create a list of suggestions for documentation that should be added
- Re-organise documentation if it is not discoverable following our documentation organisation strategy
Documentation organisation strategy:
- A
docs directory at the root of a repo
- Separate doc files with names that clearly describe what the doc file contains
- Appropriately named sub-directories where there are several related individual doc files
Assess the CIIP repo's documentation.
Things to consider:
Todo:
Documentation organisation strategy:
docsdirectory at the root of a repo