{"id":28728771,"url":"https://github.com/firelyteam/firely-docs","last_synced_at":"2025-09-10T14:20:19.032Z","repository":{"id":38404149,"uuid":"50921743","full_name":"FirelyTeam/firely-docs","owner":"FirelyTeam","description":"Documentation site for Firely FHIR tooling","archived":false,"fork":false,"pushed_at":"2025-06-11T10:58:04.000Z","size":14824,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-06-11T12:01:26.897Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.fire.ly/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FirelyTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2016-02-02T13:17:50.000Z","updated_at":"2025-06-11T10:58:03.000Z","dependencies_parsed_at":"2024-01-23T14:02:19.566Z","dependency_job_id":"10f1bff6-fa37-4154-a13c-d070f2848a93","html_url":"https://github.com/FirelyTeam/firely-docs","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/FirelyTeam/firely-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FirelyTeam%2Ffirely-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FirelyTeam%2Ffirely-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FirelyTeam%2Ffirely-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FirelyTeam%2Ffirely-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FirelyTeam","download_url":"https://codeload.github.com/FirelyTeam/firely-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FirelyTeam%2Ffirely-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259998857,"owners_count":22943879,"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":[],"created_at":"2025-06-15T15:38:40.037Z","updated_at":"2025-06-15T15:38:41.700Z","avatar_url":"https://github.com/FirelyTeam.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Firely Docs](https://docs.fire.ly/) \u0026middot; [![Documentation Status](https://readthedocs.org/projects/simplifier/badge/?version=latest)](https://docs.fire.ly/)\n\nThis is the source code for the Firely documentation site, documenting the Firely FHIR tooling, found at https://docs.fire.ly.\n\n## Subprojects\nSome of the tools are documented in separate repositories:\n* [Firely .NET SDK](https://github.com/FirelyTeam/firely-docs-firely-net-sdk)\n* [Firely Terminal](https://github.com/FirelyTeam/firely-docs-firely-terminal)\n* [Forge](https://github.com/FirelyTeam/firely-docs-forge)\n* [Simplifier.net](https://github.com/FirelyTeam/firely-docs-simplifier)\n* [Firely Server](https://github.com/FirelyTeam/firely-docs-firely-server)\n\n## Contributions\n* Contributions most welcome! Just fork the repository, make your changes and send a pull request to our master branch.\n* Spot an issue in the documentation? Feel free to [report it in our Github issues](https://github.com/FirelyTeam/firely-docs/issues).\n\n## Building locally\n1. Install dependencies: `pip install -r requirements.txt` \n2. Run `./build.bat` for a single build.\n3. For autobuild on localhost that updates when files change, install sphinx-autobuild (`pip install sphinx-autobuild`) and run: `./autobuild.bat`\n\n## Adding a new RTD subproject\n\n1. Create empty public repository on Github.com: `firely-docs-PROJECT-NAME`\n\n2. Create empty RTD project: `sphinx-quickstart`\n\n3. Copy from another subproject like https://github.com/firelyTeam/firely-docs-firely-terminal, and don't change just for your subproject to avoid diversion:\n  * In root: `build.bat`, `autobuild.bat`, `.gitignore`, `requirements.txt`\n  * In root: `README.md` and update it for your project\n  * In `_templates`: `breadcrumbs.html` (to customize top page name), `layout.html` (for Firely layout and logo link), `searchbox.html` (for accessibility label on search field)\n  * In _static: `css/style.css`, `images/banner.png`\n\n4. In conf.py:\n  * Change theme: `html_theme = 'sphinx_rtd_theme'`\n  * Set theme options:\n  \n  ```\n  master_doc = 'index'\n  html_theme_options = {'navigation_depth': 3}\n  ```\n  \n  * Set intersphinx settings to link to other RTD (sub)projects:\n  \n  ```\n  extensions = ['sphinx.ext.intersphinx']\n\n  intersphinx_mapping = {\n      'main_docs': ('https://docs.fire.ly', None),\n      }\n  ```\n\n5. Create a new project on readthedocs.org with an account with access to the [main project](https://readthedocs.org/projects/simplifier/) based on the new Github repo. Add the Firely Google Analytics code (copied from the main project) under Admin \u003e Advanced Settings.\n\n6. Add the new project as [a Subproject to the main project](https://readthedocs.org/dashboard/simplifier/subprojects/). Note: Choose a pretty Alias/slug (Project-Name) because it will be shown as project name on the search page.\n\n7. Add your project to the `intersphinx_mapping` of the main project and link it in the projects toctree. Note: toctree directive needs full urls and doesn't support intersphinx.\n\n## Best practices\n\n### Making links\n\nThe most stable way to refer to (places on) other pages seems to be:\n* Put this above where you want to link to:\n```\n.. _some_unique_tag:\n```\n* Link to it like so: \n```\n:ref:`my link text \u003csome_unique_tag\u003e`\n```\n* Or, using intersphinx, link to the other repo's page like so:\n```\n:ref:`my link text \u003cmain_docs:some_unique_tag\u003e`\n```\n\nThis makes sure you can change the file name and location for the source files. It's also easier to search your entire documentation to see if a link is used. (Don't forget to also search all other docs repos to if you're planning to remove an anchor. I put them all in one VS Workspace for this)\n\n### Embedding images\n\nMake sure to give an image a `width` tag. This makes sure it scales nicely and it can be clicked to enlarge.\n\n```\n.. image:: images/ForgeProject.png\n   :alt: Forge\n   :width: 536\n```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirelyteam%2Ffirely-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirelyteam%2Ffirely-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirelyteam%2Ffirely-docs/lists"}