Skip to content

Work out how to host docs for individual tools  #4

@adamltyson

Description

@adamltyson

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

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions