Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CIIP documentation curation #2237

Open
dleard opened this issue Jun 13, 2023 · 0 comments
Open

CIIP documentation curation #2237

dleard opened this issue Jun 13, 2023 · 0 comments

Comments

@dleard
Copy link
Contributor

dleard commented Jun 13, 2023

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants