generated from neuroinformatics-unit/HowTo
-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Ideally we want:
a) Tool-specific docs to be part of the relevant repo so that docs can be updated along with code (and autogenerated API docs)
b) All docs to be accessible via one site (brainglobe.info)
How do we do this? I haven't found any tool to automate this, the best way seems to be some kind of custom build script. The process could be something like:
- Include docs in all repos
- Have a central repo (this one) which contains general BrainGlobe info, and a script to:
- Find all repos with docs
- Copy files
- Build one large site with all appropriate links
Any ideas @alessandrofelder? We should think about this as we start to accumulate more documentation for different parts of the project.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Type
Projects
Status
Backlog