README.md

Technical Documentation for the Biomedical Data Translator

This repository hosts templates, scripts and contents for primary technical documentation for Developers and Administrators of the Biomedical Data Translator project ("Translator"; Fecho et al, 2022) of the National Center for Advancing Translational Sciences ("NCATS").

The repository uses the mkdocs tooling to generate and manage an indexed compendium of the documentation for Open Access licensed hosting on its Official Site (https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/).

Getting Started

The site uses Python (suggest 3.9 or better) and mkdocs. Assuming that you have python and pip installed on your machine, create a suitable virtual environment, then install the requirements (including mkdocs) as follows:

pip install -r requirements.txt

The repository already has core mkdocs configuration and layout, within which additional content may be added.

The following mkdocs commands are useful for the work:

• mkdocs serve - Start the live-reloading docs server on your computer.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

The Translator mkdocs documentation is hierarchically structured as follows:

mkdocs.yml         # The configuration file.
docs/
    index.md       # the documentation homepage.
    architecture/  # overview of the Translator architecture
        index.md
        ...
    deployment-guide/
        index.md   # specific hands-on developer documentation, tutorials directory
        ...
    development-guide/
        # specific hands-on developer documentation, 
        # tutorials subdirectory, Jupyter Notebook, etc
        index.md
        ...
        tutorials/
            index.md   # tutorial resources
            ...
    teams/
        index.md  # project details about Translator
        ...
    faq.md        # frequently asked questions
    glossary.md   # basic glossary of Translator buzzwords
    license.md

with some utility resources:

    img/          # shared images
    includes/     # shared site abbreviation file, etc
    stylesheets/  # CSS styles for the site