https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/

Official Developer Documentation repository for the Biomedical Data Translator
https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/

documentation mkdocs ncats-translator

Last synced: about 2 months ago
JSON representation

Official Developer Documentation repository for the Biomedical Data Translator

• Host: GitHub
• URL: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/
• Owner: NCATSTranslator
• License: cc0-1.0
• Created: 2022-06-01T13:31:40.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-06T19:23:02.000Z (about 2 months ago)
• Last Synced: 2024-11-06T20:28:23.403Z (about 2 months ago)
• Topics: documentation, mkdocs, ncats-translator
• Homepage: https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/
• Size: 614 KB
• Stars: 3
• Watchers: 44
• Forks: 17
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://ncats.nih.gov/translator) project [("Translator"; Fecho _et al,_ 2022)](https://ascpt.onlinelibrary.wiley.com/doi/10.1111/cts.13301) of the [National Center for Advancing Translational Sciences ("NCATS")](https://ncats.nih.gov).

The repository uses the [`mkdocs`](https://www.mkdocs.org/) tooling to generate and manage an indexed compendium of the documentation for [Open Access licensed](LICENSE) hosting on its [Official Site (https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/)](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:

```shell

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