{"id":13711196,"url":"https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/","last_synced_at":"2025-05-06T20:32:11.864Z","repository":{"id":37069811,"uuid":"498748960","full_name":"NCATSTranslator/TranslatorTechnicalDocumentation","owner":"NCATSTranslator","description":"Official Developer Documentation repository for the Biomedical Data Translator","archived":false,"fork":false,"pushed_at":"2024-11-06T19:23:02.000Z","size":629,"stargazers_count":3,"open_issues_count":27,"forks_count":17,"subscribers_count":44,"default_branch":"master","last_synced_at":"2024-11-06T20:28:23.403Z","etag":null,"topics":["documentation","mkdocs","ncats-translator"],"latest_commit_sha":null,"homepage":"https://ncatstranslator.github.io/TranslatorTechnicalDocumentation/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NCATSTranslator.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-01T13:31:40.000Z","updated_at":"2024-11-06T19:23:06.000Z","dependencies_parsed_at":"2023-10-04T07:23:03.133Z","dependency_job_id":"d95ab40a-6603-41b3-9b1e-632fcdeae930","html_url":"https://github.com/NCATSTranslator/TranslatorTechnicalDocumentation","commit_stats":null,"previous_names":["ncatstranslator/translatortechnicaldocumentation"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCATSTranslator%2FTranslatorTechnicalDocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCATSTranslator%2FTranslatorTechnicalDocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCATSTranslator%2FTranslatorTechnicalDocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NCATSTranslator%2FTranslatorTechnicalDocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NCATSTranslator","download_url":"https://codeload.github.com/NCATSTranslator/TranslatorTechnicalDocumentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224528348,"owners_count":17326348,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","mkdocs","ncats-translator"],"created_at":"2024-08-02T23:01:05.636Z","updated_at":"2024-11-13T21:31:35.594Z","avatar_url":"https://github.com/NCATSTranslator.png","language":null,"funding_links":[],"categories":["Curated list"],"sub_categories":["Biomedical knowledge graphs"],"readme":"# Technical Documentation for the Biomedical Data Translator\n\nThis 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).\n\nThe 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/).\n\n## Getting Started\n\nThe 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:\n\n```shell\npip install -r requirements.txt\n```\n\nThe repository already has core `mkdocs` configuration and layout, within which additional content may be added. \n\nThe following `mkdocs` commands are useful for the work:\n\n* `mkdocs serve` - Start the live-reloading docs server on your computer.\n* `mkdocs build` - Build the documentation site.\n* `mkdocs -h` - Print help message and exit.\n\n### Project layout\n\nThe Translator `mkdocs` documentation is hierarchically structured as follows:\n\n    mkdocs.yml         # The configuration file.\n    docs/\n        index.md       # the documentation homepage.\n        architecture/  # overview of the Translator architecture\n            index.md\n            ...\n        deployment-guide/\n            index.md   # specific hands-on developer documentation, tutorials directory\n            ...\n        development-guide/\n            # specific hands-on developer documentation, \n            # tutorials subdirectory, Jupyter Notebook, etc\n            index.md\n            ...\n            tutorials/\n                index.md   # tutorial resources\n                ...\n        teams/\n            index.md  # project details about Translator\n            ...\n        faq.md        # frequently asked questions\n        glossary.md   # basic glossary of Translator buzzwords\n        license.md\n\nwith some utility resources:\n\n        img/          # shared images\n        includes/     # shared site abbreviation file, etc\n        stylesheets/  # CSS styles for the site\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/ncatstranslator.github.io%2FTranslatorTechnicalDocumentation%2F","html_url":"https://awesome.ecosyste.ms/projects/ncatstranslator.github.io%2FTranslatorTechnicalDocumentation%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/ncatstranslator.github.io%2FTranslatorTechnicalDocumentation%2F/lists"}