-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnice to have
Description
Would it make sense to integrate our data documentation into the \docs\ folder of this repo so that all of the documentation would be available in one place as the docs for the code? This might look like having a code and data documentation sections on the website (present site is here) Some benefits of this might be...
- We could host meta-data about our datasets in the repository itself.
- Having datasets and documentation together will probably make it easier to keep docs up to date (OSF is already a bit out of date)
- We could probably integrate some kind of variables that keep track of when each dataset was last updated (especially for live datasets), and this would automatically update this information in the documentation too.
We made the Sphynx site quite last minute so I think there's a lot we could do to make it look nicer and fit better with the theme of the main site. We could then add a documentation option to the navbar?
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnice to have