{"id":40523064,"url":"https://github.com/dockstore/dockstore-documentation","last_synced_at":"2026-01-20T21:12:51.672Z","repository":{"id":36455598,"uuid":"181076398","full_name":"dockstore/dockstore-documentation","owner":"dockstore","description":"The documentation for Dockstore.org","archived":false,"fork":false,"pushed_at":"2025-11-27T08:03:11.000Z","size":70997,"stargazers_count":2,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-11-30T01:26:35.476Z","etag":null,"topics":["cwl","dockstore","hacktoberfest","nextflow","tool","wdl","workflow"],"latest_commit_sha":null,"homepage":"https://dockstore.readthedocs.io","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dockstore.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":"docs/roadmap.rst","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-04-12T20:06:51.000Z","updated_at":"2025-08-11T14:12:00.000Z","dependencies_parsed_at":"2024-12-13T17:25:41.491Z","dependency_job_id":"1263c2c6-8915-4770-af11-ac73f421c7fd","html_url":"https://github.com/dockstore/dockstore-documentation","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/dockstore/dockstore-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockstore%2Fdockstore-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockstore%2Fdockstore-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockstore%2Fdockstore-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockstore%2Fdockstore-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dockstore","download_url":"https://codeload.github.com/dockstore/dockstore-documentation/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockstore%2Fdockstore-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28613889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T18:56:40.769Z","status":"ssl_error","status_checked_at":"2026-01-20T18:54:26.653Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cwl","dockstore","hacktoberfest","nextflow","tool","wdl","workflow"],"created_at":"2026-01-20T21:12:50.527Z","updated_at":"2026-01-20T21:12:51.665Z","avatar_url":"https://github.com/dockstore.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dockstore Documentation\n\nDockstore is using [Read the Docs](https://readthedocs.org/) for documentation! Please take a look at [our style guide](./style-guide.md) to learn about our approach to documentation.\n\nBelow are some tips for setting up the documentation locally and updating the code.\n\n## Setting up locally\n\nInstall pip dependencies (Requires Python 3.9+)\n`pip install -r requirements.txt`\n\nGo to the docs directory\n`cd docs`\n\nGenerate the HTML to generate HTML pages in a new folder called `_build`\n`make html`\n\nCheck for broken links\n`make linkcheck`\n\nOpen the `_build/html/index.html` in your browser!\n\nOICR partners can view additional developer docs here: https://wiki.oicr.on.ca/display/DOC/Read+The+Docs\n\n## Writing/Maintaining docs\nMost of our docs are written in RST. A handful are written are in markdown. Both the RST and markdown documents will be rendered as HTML using the Python-based documentation manager Sphinx.\n\nMost of our docs can be maintained by modifying individual RST and MD files directly. There are a few exceptions:\n* When creating a new page, it must exist on the table of contents (`toctree`) which forms the sidebar on the left — in most cases this requires adding a new entry to index.rst\n* dictionary.rst is generated from entries in `docs/_attic/glossary_entries.py` by `docs/_attic/glossary_generator.py` in order to easily handle the complexities of large RST documents — dictionary.rst is regenerated upon every `make` command (changes will not appear in git unless `docs/_attic/glossary_entries.py` is modified), but this regeneration can also be called explictly with `make glossary`\n* Certain doi.org links, plus any images that link to internal documents, must have those links added to `linkcheck_ignore` in conf.py\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdockstore%2Fdockstore-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdockstore%2Fdockstore-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdockstore%2Fdockstore-documentation/lists"}