Skip to content

194 release205#198

Merged
aslgraefe merged 32 commits into
developfrom
194-release205
Dec 12, 2025
Merged

194 release205#198
aslgraefe merged 32 commits into
developfrom
194-release205

Conversation

@aslgraefe

@aslgraefe aslgraefe commented Dec 12, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • New Features

    • Manual data capture now supports medical procedures; medical actions can be mapped (MAXO).
    • Phenopacket export: expanded advanced configuration (multi-instrument, multi-onset, mapping controls).
  • Documentation

    • README and docs updated with reworded project description, citation, obfuscated contact, ontology/name updates, and standardized version references.
  • Chores

    • Pruned packaging/manifests and removed generated build artifacts; updated ignore rules.

✏️ Tip: You can customize this high-level summary in your review settings.

@aslgraefe aslgraefe linked an issue Dec 12, 2025 that may be closed by this pull request
9 tasks
@coderabbitai

coderabbitai Bot commented Dec 12, 2025

Copy link
Copy Markdown

Warning

Rate limit exceeded

@aslgraefe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2c31cde and 87d067b.

📒 Files selected for processing (1)
  • README.md (8 hunks)

Walkthrough

Documentation and build-artifact cleanup: README and documentation source pages updated (text, version references, ontology entries, citation, contact obfuscation, LinkML path updates, measurement/procedure guidance); downloads-manifest doc removed; large set of generated HTML/CSS/JS assets and build metadata deleted from docs/_build.

Changes

Cohort / File(s) Summary
Repo metadata & README
\.gitignore, MANIFEST.in, README.md
.gitignore now ignores RELEASE.md; MANIFEST.in pruning updated to exclude build/dist; README.md rewritten with new description, citation, TOC entry, obfuscated contact, ontology name fixes, version/path updates, and other editorial changes.
Documentation sources — background & ontologies
docs/1_background/1_0_background_file.rst, docs/1_background/1_2_ontologies.rst, docs/1_background/1_5_rd_cdm.rst
Inserted manuscript tip blocks; added MAXO code system; updated ontology references and RD‑CDM version/figure/path text to be version-agnostic (v2.0.2 → v2.0.0/v2.0).
Documentation sources — RareLink framework
docs/2_rarelink_framework/2_0_rarelink_file.rst, docs/2_rarelink_framework/2_1_rarelink_overview.rst, docs/2_rarelink_framework/2_2_rarelink_cdm.rst, docs/2_rarelink_framework/2_3_rarelink_cli.rst
Added manuscript tips; updated LinkML schema and python_datamodel paths (v2_0_2 → rarelink/rarelink_cdm/...); IPS version references adjusted (v2.0.2 → v2.0.0); minor whitespace edits.
Documentation sources — installation & user guide
docs/3_installation/3_3_data_dictionary.rst, docs/4_user_guide/4_1_manual_data_capture.rst, docs/4_user_guide/4_2_import_mapper.rst, docs/4_user_guide/4_3_phenopackets.rst
Replaced explicit download links with `
Documentation sources — contact, changelog, acknowledgements
docs/6_changelog.rst, docs/9_acknowledgements.rst, docs/12_contact.rst
Added v2.0.5 changelog header and date; fixed typo; obfuscated contact email; updated acknowledgement wording to include “and colleagues.”
Removed docs: downloads manifest (source)
docs/11_download_manifest.rst
Deleted page describing downloads manifest purpose, structure, hosted location, and CLI fetch behavior.
Deleted: generated HTML pages
docs/_build/*.html, docs/_build/**/**/*.html
Removed prebuilt/generated HTML artifacts across docs/_build (license, contact, background, framework, installation, user guide, contributing, changelog, FAQ, glossary, acknowledgements, genindex, etc.).
Deleted: HTML source backups
docs/_build/_sources/*.rst.txt, docs/_build/_sources/**/*.rst.txt
Removed all generated source backup files used for the prebuilt HTML pages.
Deleted: static assets (CSS/JS/images)
docs/_build/_static/*.css, docs/_build/_static/*.js, docs/_build/_static/js/*, docs/_build/_static/css/*, docs/_build/_static/jquery.js, docs/_build/_static/language_data.js, docs/_build/_static/searchtools.js, docs/_build/_static/theme.js, docs/_build/_static/versions.js, docs/_build/_static/doctools.js, ...
Removed theme and utility assets (basic.css, custom.css, pygments.css, copybutton.css, copybutton.js, copybutton_funcs.js, sphinx_highlight.js, searchtools.js, doctools.js, theme.js, versions.js, _sphinx_javascript_frameworks_compat.js, jquery.js, language_data.js, badge_only assets, documentation_options.js, and related static files).
Deleted: downloads manifest & archives
docs/_build/_static/downloads_manifest.json, docs/_build/_downloads/*
Removed the downloads_manifest.json entry for rarelink_cdm_datadictionary v2_0_2 and associated download archive files.
Deleted: build metadata & backups
docs/_build/.buildinfo, docs/_build/.buildinfo.bak, docs/_build/html/.buildinfo, docs/_build/html/.buildinfo.bak
Removed Sphinx build metadata and backup files; one html/.buildinfo was updated (config hash change).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Areas needing close review:
    • README content and citation/links correctness.
    • Consistency of version edits (v2.0.2 → v2.0.0/v2.0) across docs and references.
    • LinkML path updates and any placeholders (e.g., |data_dict_download|) resolving correctly in documentation builds.
    • New measurement→procedure guidance (MAXO/FHIR/Phenopackets) for accuracy.
    • Confirm intentional removal of all docs/_build generated assets (ensures no required static assets were accidentally deleted).

Possibly related PRs

  • patch 11 mar #141 — edits to docs/2_rarelink_framework/2_3_rarelink_cli.rst; overlaps with deletion/changes to the same CLI doc.
  • 194 release205 #198 — touches README, MANIFEST.in and docs; shares similar documentation and manifest modifications.
  • Release/2.0.4 #189 — related README/docs edits and version/reference updates across documentation.

Poem

🐰 Hopped through docs with careful paws and brush,

Trimmed old builds and gave the README a hush;
MAXO hops in, versions aligned just so,
Downloads retired, and placeholders grow.
The burrow looks tidy — a neat little glow! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title "194 release205" is vague and does not clearly describe the main purpose of the changeset, which involves comprehensive documentation updates, version changes, and build artifact cleanup. Provide a more descriptive title that summarizes the primary changes, such as 'Update documentation for v2.0.5 release and clean up build artifacts' or 'Release 2.0.5: Documentation updates and version references'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
docs/9_acknowledgements.rst (2)

1-1: Fix typo in section title.

The section title contains a typo: "Acknowlegements" should be "Acknowledgements".

-Acknowlegements
+Acknowledgements

4-5: Fix line break artifact in introductory text.

The text appears to have an awkward line break with "W" isolated at the end of line 4. Verify the intended text flow and correct the formatting.

-We specifically thank all the contributors to the RareLink project. W
-e also acknowledge the following organizations for their support and collaboration:
+We specifically thank all the contributors to the RareLink project. We also acknowledge the following organizations for their support and collaboration:
🧹 Nitpick comments (4)
docs/1_background/1_0_background_file.rst (1)

6-8: Avoid time-relative wording (“recently”) and prefer a proper reST link.
Consider changing “recently published” to a date/year (or just “published”), and formatting the URL as an inline link for consistency/readability.

docs/2_rarelink_framework/2_0_rarelink_file.rst (1)

6-8: Same manuscript tip: avoid “recently” + format as reST link for consistency.

docs/2_rarelink_framework/2_1_rarelink_overview.rst (1)

6-8: Same manuscript tip: avoid “recently” + format as reST link for consistency.

README.md (1)

18-19: Prefer relative LICENSE links over blob/develop/... (avoids branch coupling).

-[![License: Apache v2.0](https://img.shields.io/badge/License-Apache2.0-yellow.svg)](https://github.com/BIH-CEI/rarelink/blob/develop/LICENSE)
+[![License: Apache v2.0](https://img.shields.io/badge/License-Apache2.0-yellow.svg)](LICENSE)
@@
-This project is licensed under the terms of the [open-source Apache 2.0 License](https://github.com/BIH-CEI/RareLink/blob/develop/LICENSE)
+This project is licensed under the terms of the [open-source Apache 2.0 License](LICENSE)

Also applies to: 265-268

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb29691 and 2c31cde.

⛔ Files ignored due to path filters (84)
  • .DS_Store is excluded by !**/.DS_Store
  • docs/.DS_Store is excluded by !**/.DS_Store
  • docs/_build/.doctrees/environment.pickle is excluded by !**/*.pickle
  • docs/_build/_images/DataDictionary.jpg is excluded by !**/*.jpg
  • docs/_build/_images/DesignerTab.jpg is excluded by !**/*.jpg
  • docs/_build/_images/fhir_release4_logo.jpg is excluded by !**/*.jpg
  • docs/_build/_images/rarelink-cdm-repeating-instruments.jpg is excluded by !**/*.jpg
  • docs/_build/_images/rarelink_overview.svg is excluded by !**/*.svg
  • docs/_build/_images/rd_cdm_v2_0_0.jpeg is excluded by !**/*.jpeg
  • docs/_build/_images/redcap_project_mode.jpg is excluded by !**/*.jpg
  • docs/_build/_static/check-solid.svg is excluded by !**/*.svg
  • docs/_build/_static/clipboard.min.js is excluded by !**/*.min.js
  • docs/_build/_static/copy-button.svg is excluded by !**/*.svg
  • docs/_build/_static/css/fonts/Roboto-Slab-Bold.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/Roboto-Slab-Bold.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/Roboto-Slab-Regular.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/Roboto-Slab-Regular.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/fontawesome-webfont.eot is excluded by !**/*.eot
  • docs/_build/_static/css/fonts/fontawesome-webfont.svg is excluded by !**/*.svg
  • docs/_build/_static/css/fonts/fontawesome-webfont.ttf is excluded by !**/*.ttf
  • docs/_build/_static/css/fonts/fontawesome-webfont.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/fontawesome-webfont.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/lato-bold-italic.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/lato-bold-italic.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/lato-bold.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/lato-bold.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/lato-normal-italic.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/lato-normal-italic.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/css/fonts/lato-normal.woff is excluded by !**/*.woff
  • docs/_build/_static/css/fonts/lato-normal.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/file.png is excluded by !**/*.png
  • docs/_build/_static/fonts/Lato/lato-bold.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/Lato/lato-bold.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/Lato/lato-bold.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/Lato/lato-bold.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/fonts/Lato/lato-bolditalic.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/Lato/lato-bolditalic.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/Lato/lato-bolditalic.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/Lato/lato-bolditalic.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/fonts/Lato/lato-italic.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/Lato/lato-italic.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/Lato/lato-italic.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/Lato/lato-italic.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/fonts/Lato/lato-regular.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/Lato/lato-regular.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/Lato/lato-regular.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/Lato/lato-regular.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot is excluded by !**/*.eot
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf is excluded by !**/*.ttf
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff is excluded by !**/*.woff
  • docs/_build/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 is excluded by !**/*.woff2
  • docs/_build/_static/minus.png is excluded by !**/*.png
  • docs/_build/_static/plus.png is excluded by !**/*.png
  • docs/_build/_static/res/RD CDM UML.png is excluded by !**/*.png
  • docs/_build/_static/res/RD CDM UML.svg is excluded by !**/*.svg
  • docs/_build/_static/res/RareLink SpinxDocs Logo.png is excluded by !**/*.png
  • docs/_build/_static/res/fhir_release4_logo.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/import_mapper_tsvs/example_1_sssom.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/example_2.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/example_2_sssom.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/example_2_sssom.tsv is excluded by !**/*.tsv
  • docs/_build/_static/res/import_mapper_tsvs/example_3.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/example_3_sssom.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/example_3_sssom.tsv is excluded by !**/*.tsv
  • docs/_build/_static/res/import_mapper_tsvs/old_files/example_2.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/old_files/example_2_sssom.tsv is excluded by !**/*.tsv
  • docs/_build/_static/res/import_mapper_tsvs/old_files/example_3.csv is excluded by !**/*.csv
  • docs/_build/_static/res/import_mapper_tsvs/old_files/example_3_sssom.tsv is excluded by !**/*.tsv
  • docs/_build/_static/res/import_mapper_tsvs/rarelink_cdm_sssom_template.csv is excluded by !**/*.csv
  • docs/_build/_static/res/phenopacket-schema-v2-overview.png is excluded by !**/*.png
  • docs/_build/_static/res/rarelink-cdm-repeating-instruments.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/rarelink_overview.svg is excluded by !**/*.svg
  • docs/_build/_static/res/rd_cdm_v2_0_0.jpeg is excluded by !**/*.jpeg
  • docs/_build/_static/res/redcap_gui_screenshots/DataDictionary.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/redcap_gui_screenshots/DesignerTab.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/redcap_gui_screenshots/repeating_buttons.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/redcap_gui_screenshots/repeating_buttons_2.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/redcap_project_mode.jpg is excluded by !**/*.jpg
  • docs/_build/_static/res/redcap_world_map.jpg is excluded by !**/*.jpg
  • docs/_build/doctrees/environment.pickle is excluded by !**/*.pickle
📒 Files selected for processing (106)
  • .gitignore (1 hunks)
  • MANIFEST.in (1 hunks)
  • README.md (8 hunks)
  • docs/11_download_manifest.rst (0 hunks)
  • docs/12_contact.rst (1 hunks)
  • docs/1_background/1_0_background_file.rst (1 hunks)
  • docs/1_background/1_2_ontologies.rst (1 hunks)
  • docs/1_background/1_5_rd_cdm.rst (3 hunks)
  • docs/2_rarelink_framework/2_0_rarelink_file.rst (1 hunks)
  • docs/2_rarelink_framework/2_1_rarelink_overview.rst (1 hunks)
  • docs/2_rarelink_framework/2_2_rarelink_cdm.rst (5 hunks)
  • docs/2_rarelink_framework/2_3_rarelink_cli.rst (0 hunks)
  • docs/3_installation/3_3_data_dictionary.rst (1 hunks)
  • docs/4_user_guide/4_1_manual_data_capture.rst (2 hunks)
  • docs/4_user_guide/4_2_import_mapper.rst (3 hunks)
  • docs/4_user_guide/4_3_phenopackets.rst (2 hunks)
  • docs/6_changelog.rst (1 hunks)
  • docs/9_acknowledgements.rst (1 hunks)
  • docs/_build/.buildinfo (0 hunks)
  • docs/_build/.buildinfo.bak (0 hunks)
  • docs/_build/10_license.html (0 hunks)
  • docs/_build/11_download_manifest.html (0 hunks)
  • docs/_build/12_contact.html (0 hunks)
  • docs/_build/1_background/1_0_background_file.html (0 hunks)
  • docs/_build/1_background/1_1_rd_interoperability.html (0 hunks)
  • docs/_build/1_background/1_2_ontologies.html (0 hunks)
  • docs/_build/1_background/1_3_ga4gh_phenopacket_schema.html (0 hunks)
  • docs/_build/1_background/1_4_hl7_fhir.html (0 hunks)
  • docs/_build/1_background/1_5_rd_cdm.html (0 hunks)
  • docs/_build/1_background/1_6_redcap.html (0 hunks)
  • docs/_build/2_rarelink_framework/2_0_rarelink_file.html (0 hunks)
  • docs/_build/2_rarelink_framework/2_1_rarelink_overview.html (0 hunks)
  • docs/_build/2_rarelink_framework/2_2_rarelink_cdm.html (0 hunks)
  • docs/_build/2_rarelink_framework/2_3_rarelink_cli.html (0 hunks)
  • docs/_build/3_installation/3_0_install_file.html (0 hunks)
  • docs/_build/3_installation/3_1_setup_rarelink_framework.html (0 hunks)
  • docs/_build/3_installation/3_2_setup_redcap_project.html (0 hunks)
  • docs/_build/3_installation/3_3_data_dictionary.html (0 hunks)
  • docs/_build/3_installation/3_4_redcap_api.html (0 hunks)
  • docs/_build/4_user_guide/4_0_guide_file.html (0 hunks)
  • docs/_build/4_user_guide/4_1_manual_data_capture.html (0 hunks)
  • docs/_build/4_user_guide/4_2_import_mapper.html (0 hunks)
  • docs/_build/4_user_guide/4_3_phenopackets.html (0 hunks)
  • docs/_build/4_user_guide/4_4_tofhir_module.html (0 hunks)
  • docs/_build/4_user_guide/4_5_develop_redcap_instruments.html (0 hunks)
  • docs/_build/4_user_guide/4_6_redcap_tools.html (0 hunks)
  • docs/_build/5_contributing.html (0 hunks)
  • docs/_build/6_changelog.html (0 hunks)
  • docs/_build/7_faq.html (0 hunks)
  • docs/_build/8_glossary.html (0 hunks)
  • docs/_build/9_acknowledgements.html (0 hunks)
  • docs/_build/_downloads/be2e33b5e674cd00f02b65650407213c/downloads_manifest.json (0 hunks)
  • docs/_build/_sources/10_license.rst.txt (0 hunks)
  • docs/_build/_sources/11_download_manifest.rst.txt (0 hunks)
  • docs/_build/_sources/12_contact.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_0_background_file.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_1_rd_interoperability.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_2_ontologies.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_3_ga4gh_phenopacket_schema.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_4_hl7_fhir.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_5_rd_cdm.rst.txt (0 hunks)
  • docs/_build/_sources/1_background/1_6_redcap.rst.txt (0 hunks)
  • docs/_build/_sources/2_rarelink_framework/2_0_rarelink_file.rst.txt (0 hunks)
  • docs/_build/_sources/2_rarelink_framework/2_1_rarelink_overview.rst.txt (0 hunks)
  • docs/_build/_sources/2_rarelink_framework/2_2_rarelink_cdm.rst.txt (0 hunks)
  • docs/_build/_sources/2_rarelink_framework/2_3_rarelink_cli.rst.txt (0 hunks)
  • docs/_build/_sources/3_installation/3_0_install_file.rst.txt (0 hunks)
  • docs/_build/_sources/3_installation/3_1_setup_rarelink_framework.rst.txt (0 hunks)
  • docs/_build/_sources/3_installation/3_2_setup_redcap_project.rst.txt (0 hunks)
  • docs/_build/_sources/3_installation/3_3_data_dictionary.rst.txt (0 hunks)
  • docs/_build/_sources/3_installation/3_4_redcap_api.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_0_guide_file.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_1_manual_data_capture.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_2_import_mapper.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_3_phenopackets.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_4_tofhir_module.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_5_develop_redcap_instruments.rst.txt (0 hunks)
  • docs/_build/_sources/4_user_guide/4_6_redcap_tools.rst.txt (0 hunks)
  • docs/_build/_sources/5_contributing.rst.txt (0 hunks)
  • docs/_build/_sources/6_changelog.rst.txt (0 hunks)
  • docs/_build/_sources/7_faq.rst.txt (0 hunks)
  • docs/_build/_sources/8_glossary.rst.txt (0 hunks)
  • docs/_build/_sources/9_acknowledgements.rst.txt (0 hunks)
  • docs/_build/_sources/index.rst.txt (0 hunks)
  • docs/_build/_static/_sphinx_javascript_frameworks_compat.js (0 hunks)
  • docs/_build/_static/basic.css (0 hunks)
  • docs/_build/_static/copybutton.css (0 hunks)
  • docs/_build/_static/copybutton.js (0 hunks)
  • docs/_build/_static/copybutton_funcs.js (0 hunks)
  • docs/_build/_static/css/badge_only.css (0 hunks)
  • docs/_build/_static/custom.css (0 hunks)
  • docs/_build/_static/custom.js (0 hunks)
  • docs/_build/_static/doctools.js (0 hunks)
  • docs/_build/_static/documentation_options.js (0 hunks)
  • docs/_build/_static/downloads_manifest.json (0 hunks)
  • docs/_build/_static/jquery.js (0 hunks)
  • docs/_build/_static/js/badge_only.js (0 hunks)
  • docs/_build/_static/js/theme.js (0 hunks)
  • docs/_build/_static/js/versions.js (0 hunks)
  • docs/_build/_static/language_data.js (0 hunks)
  • docs/_build/_static/pygments.css (0 hunks)
  • docs/_build/_static/searchtools.js (0 hunks)
  • docs/_build/_static/sphinx_highlight.js (0 hunks)
  • docs/_build/genindex.html (0 hunks)
  • docs/_build/html/.buildinfo (1 hunks)
  • docs/_build/html/.buildinfo.bak (0 hunks)
💤 Files with no reviewable changes (89)
  • docs/11_download_manifest.rst
  • docs/_build/8_glossary.html
  • docs/_build/_sources/4_user_guide/4_4_tofhir_module.rst.txt
  • docs/_build/4_user_guide/4_6_redcap_tools.html
  • docs/_build/6_changelog.html
  • docs/_build/_sources/6_changelog.rst.txt
  • docs/_build/_static/copybutton.js
  • docs/_build/4_user_guide/4_2_import_mapper.html
  • docs/_build/_sources/4_user_guide/4_0_guide_file.rst.txt
  • docs/_build/2_rarelink_framework/2_0_rarelink_file.html
  • docs/_build/4_user_guide/4_3_phenopackets.html
  • docs/_build/_sources/7_faq.rst.txt
  • docs/_build/1_background/1_6_redcap.html
  • docs/2_rarelink_framework/2_3_rarelink_cli.rst
  • docs/_build/7_faq.html
  • docs/_build/_static/custom.js
  • docs/_build/_sources/index.rst.txt
  • docs/_build/_sources/1_background/1_6_redcap.rst.txt
  • docs/_build/_sources/12_contact.rst.txt
  • docs/_build/3_installation/3_1_setup_rarelink_framework.html
  • docs/_build/_sources/3_installation/3_3_data_dictionary.rst.txt
  • docs/_build/_sources/9_acknowledgements.rst.txt
  • docs/_build/_sources/1_background/1_3_ga4gh_phenopacket_schema.rst.txt
  • docs/_build/_sources/3_installation/3_2_setup_redcap_project.rst.txt
  • docs/_build/_sources/4_user_guide/4_5_develop_redcap_instruments.rst.txt
  • docs/_build/1_background/1_1_rd_interoperability.html
  • docs/_build/_static/custom.css
  • docs/_build/_static/downloads_manifest.json
  • docs/_build/4_user_guide/4_1_manual_data_capture.html
  • docs/_build/_static/css/badge_only.css
  • docs/_build/11_download_manifest.html
  • docs/_build/_sources/2_rarelink_framework/2_2_rarelink_cdm.rst.txt
  • docs/_build/_sources/10_license.rst.txt
  • docs/_build/_static/jquery.js
  • docs/_build/.buildinfo
  • docs/_build/_sources/1_background/1_5_rd_cdm.rst.txt
  • docs/_build/1_background/1_5_rd_cdm.html
  • docs/_build/_sources/3_installation/3_0_install_file.rst.txt
  • docs/_build/_sources/4_user_guide/4_1_manual_data_capture.rst.txt
  • docs/_build/_sources/11_download_manifest.rst.txt
  • docs/_build/5_contributing.html
  • docs/_build/_sources/1_background/1_0_background_file.rst.txt
  • docs/_build/2_rarelink_framework/2_1_rarelink_overview.html
  • docs/_build/_static/doctools.js
  • docs/_build/_sources/2_rarelink_framework/2_0_rarelink_file.rst.txt
  • docs/_build/_sources/4_user_guide/4_3_phenopackets.rst.txt
  • docs/_build/_static/pygments.css
  • docs/_build/4_user_guide/4_4_tofhir_module.html
  • docs/_build/3_installation/3_4_redcap_api.html
  • docs/_build/_static/basic.css
  • docs/_build/3_installation/3_3_data_dictionary.html
  • docs/_build/_sources/4_user_guide/4_2_import_mapper.rst.txt
  • docs/_build/_static/copybutton.css
  • docs/_build/10_license.html
  • docs/_build/9_acknowledgements.html
  • docs/_build/_sources/5_contributing.rst.txt
  • docs/_build/_static/documentation_options.js
  • docs/_build/_sources/1_background/1_1_rd_interoperability.rst.txt
  • docs/_build/_sources/4_user_guide/4_6_redcap_tools.rst.txt
  • docs/_build/_downloads/be2e33b5e674cd00f02b65650407213c/downloads_manifest.json
  • docs/_build/_static/searchtools.js
  • docs/_build/_sources/3_installation/3_4_redcap_api.rst.txt
  • docs/_build/_sources/3_installation/3_1_setup_rarelink_framework.rst.txt
  • docs/_build/_sources/8_glossary.rst.txt
  • docs/_build/4_user_guide/4_5_develop_redcap_instruments.html
  • docs/_build/_static/copybutton_funcs.js
  • docs/_build/.buildinfo.bak
  • docs/_build/_sources/1_background/1_2_ontologies.rst.txt
  • docs/_build/1_background/1_0_background_file.html
  • docs/_build/3_installation/3_0_install_file.html
  • docs/_build/_sources/2_rarelink_framework/2_3_rarelink_cli.rst.txt
  • docs/_build/2_rarelink_framework/2_3_rarelink_cli.html
  • docs/_build/genindex.html
  • docs/_build/html/.buildinfo.bak
  • docs/_build/_static/language_data.js
  • docs/_build/_sources/2_rarelink_framework/2_1_rarelink_overview.rst.txt
  • docs/_build/_static/sphinx_highlight.js
  • docs/_build/2_rarelink_framework/2_2_rarelink_cdm.html
  • docs/_build/1_background/1_4_hl7_fhir.html
  • docs/_build/12_contact.html
  • docs/_build/_static/js/theme.js
  • docs/_build/1_background/1_2_ontologies.html
  • docs/_build/3_installation/3_2_setup_redcap_project.html
  • docs/_build/_sources/1_background/1_4_hl7_fhir.rst.txt
  • docs/_build/_static/_sphinx_javascript_frameworks_compat.js
  • docs/_build/_static/js/badge_only.js
  • docs/_build/4_user_guide/4_0_guide_file.html
  • docs/_build/_static/js/versions.js
  • docs/_build/1_background/1_3_ga4gh_phenopacket_schema.html
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

9-9: Bare URL used

(MD034, no-bare-urls)


282-282: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: run-ci (3.11)
  • GitHub Check: run-ci (3.10)
  • GitHub Check: run-ci (3.12)
🔇 Additional comments (16)
docs/9_acknowledgements.rst (1)

12-12: Acknowledgement update looks good.

The addition of "and colleagues" after Prof. Oya Beyan is consistent with the pattern established elsewhere in the document (Prof. Sylvia Thun and Prof. Peter N. Robinson), making the acknowledgement structure uniform and balanced.

docs/1_background/1_5_rd_cdm.rst (1)

27-30: No action needed. The referenced SVG file docs/_static/res/rd_cdm_v2_0_0.svg exists in the repository and is correctly named.

docs/3_installation/3_3_data_dictionary.rst (1)

27-31: > Likely an incorrect or invalid review comment.

docs/1_background/1_2_ontologies.rst (1)

97-105: Use consistent capitalization for the Medical Action Ontology acronym (MAXO vs. MAxO).

Lines 97–100 mix "MAXO" (in the link label) and "MAxO" (in the description text), while other documentation sections and the official BioPortal URL consistently use "MAXO" in all caps. Align the text to match the standard capitalization.

docs/4_user_guide/4_1_manual_data_capture.rst (1)

433-436: The guidance is accurate. The procedure category value is a valid and supported measurement category in the system configuration, and MAXO integration is formally implemented across schemas and code. The statement about HPO team reliance on MAXO aligns with internal system documentation. No changes needed.

docs/4_user_guide/4_2_import_mapper.rst (1)

63-65: The schema paths in the documentation are correct. The file src/rarelink/rarelink_cdm/schema_definitions/rarelink_cdm.yaml exists in the repository, and the directory structure matches the references in the GitHub links at lines 63-65. The command example at lines 384-385 uses the correct path.

docs/4_user_guide/4_3_phenopackets.rst (4)

440-490: Advanced Configuration Options section is well-documented.

The new Advanced Configuration Options section (lines 440–490) provides clear guidance on multiple instruments, data model specification, type fields, multi-onset support, and field scanning control. The code examples and explanations are clear and actionable.


429-429: medical_actions block is fully supported in the engine.

Verification confirms that medical_actions is implemented across the Phenopacket engine: it is processed in create.py, mapped through medical_action_mapper.py, and integrated into the metadata mapping pipeline. The documentation at line 429 is accurate.


435-439: No action required—file references are accurate.

The documentation correctly references combined.py and the mappings directory. Both exist at the specified locations (src/rarelink/rarelink_cdm/mappings/phenopackets/combined.py and src/rarelink/rarelink_cdm/mappings/phenopackets/), and the mapping configuration files are present and available for users to consult.


89-89: No action required. The GitHub path in line 89 of docs/4_user_guide/4_3_phenopackets.rst is already consistent with all other documentation references. All GitHub links across the codebase consistently use the full nested path src/rarelink/rarelink_cdm (plus subdirectories where applicable). The documentation does not need updates.

docs/2_rarelink_framework/2_2_rarelink_cdm.rst (2)

39-39: Placeholder is properly defined. The |data_dict_download| placeholder is defined in docs/conf.py (line 77) with the substitution .. |data_dict_download| replace:: {download_role}, so no action is required.


71-71: The referenced GitHub paths (schema_definitions and python_datamodel in src/rarelink/rarelink_cdm/) exist in the repository with substantive content. Both directories contain multiple files and are stable parts of the codebase.

.gitignore (1)

28-29: Ignoring RELEASE.md looks fine—just ensure it’s not meant to be versioned (e.g., release notes).

MANIFEST.in (1)

25-30: Good sdist hygiene: pruning build/ and dist/ should prevent packaging local artifacts.

docs/12_contact.rst (1)

9-12: Email obfuscation is a good doc-only change (less scraping).

docs/6_changelog.rst (1)

13-15: Typo fix (“config”) looks good.

Comment on lines 1 to 4
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 501d3d1fbf9658a133c4569be302d283
config: 464fa9d75306d64cd35473965feae718
tags: 645f666f9bcd5a90fca523b33c5a78b7

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if docs/_build is in .gitignore
echo "=== Checking .gitignore for docs/_build ==="
if [ -f .gitignore ]; then
  grep -n "docs/_build" .gitignore || echo "No match found"
else
  echo ".gitignore not found"
fi

echo ""
echo "=== Checking if docs/_build/ entries exist in git ==="
git ls-files "docs/_build/" | head -20

echo ""
echo "=== Git status for docs/_build directory ==="
git status "docs/_build/" 2>/dev/null | head -10

Repository: BIH-CEI/rarelink

Length of output: 1489


Remove generated build artifacts from version control and add proper .gitignore configuration.

The .buildinfo file and all contents of docs/_build/ are auto-generated by Sphinx and should not be committed to the repository. Currently, .gitignore does not exclude this directory, and numerous build artifacts (.doctree files, .buildinfo, HTML files) are tracked in git.

Add docs/_build/ to .gitignore and remove the entire docs/_build/ directory from version control so it regenerates as part of the documentation build process.

🤖 Prompt for AI Agents
In docs/_build/html/.buildinfo around lines 1 to 4, the file is a generated
Sphinx artifact and should not be committed; update the repo to ignore the
entire docs/_build/ tree and stop tracking its current contents. Edit .gitignore
to add a line "docs/_build/" (or equivalent pattern), then remove the tracked
build artifacts from git with a command like "git rm -r --cached docs/_build"
(or remove the files via your Git client), commit the change and the removal,
and push so the docs/_build/ directory and files (including .buildinfo) will be
regenerated locally by the documentation build rather than stored in the
repository.

Comment thread docs/6_changelog.rst
Comment on lines +6 to +9
v2.0.5 (2025-11-19)
---------------------


Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Avoid an empty v2.0.5 changelog section (add bullets/TBD or drop until content exists).

 v2.0.5 (2025-11-19)
 ---------------------
 
+*TBD*
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
v2.0.5 (2025-11-19)
---------------------
v2.0.5 (2025-11-19)
---------------------
*TBD*
🤖 Prompt for AI Agents
In docs/6_changelog.rst around lines 6 to 9 the v2.0.5 header is empty; either
populate it with bullet entries or a clear placeholder (e.g., "- TBD: list
changes here") or remove the entire v2.0.5 section until there are real changes;
if adding text, ensure the underline length matches the header and follow
existing changelog bullet formatting.

Comment thread README.md Outdated
Comment on lines +8 to +9
> **Note**: The corresponding paper was recently published in npj Genomic Medicine!
You can read it here: https://www.nature.com/articles/s41525-025-00534-z

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix MD034: replace bare URLs with proper markdown links (Note + Citing).

-> **Note**: The corresponding paper was recently published in npj Genomic Medicine! 
-  You can read it here: https://www.nature.com/articles/s41525-025-00534-z
+> **Note**: The corresponding paper was recently published in npj Genomic Medicine!
+  You can read it [here](https://www.nature.com/articles/s41525-025-00534-z).
@@
 > Graefe, A.S.L., Rehburg, F., Alkarkoukly, S. et al. RareLink: scalable 
   REDCap-based framework for rare disease interoperability linking 
   international registries to FHIR and Phenopackets. 
-  npj Genom. Med. 10, 72 (2025). https://doi.org/10.1038/s41525-025-00534-z
+  npj Genom. Med. 10, 72 (2025). https://doi.org/10.1038/s41525-025-00534-z
+  ([DOI](https://doi.org/10.1038/s41525-025-00534-z))

Also applies to: 279-283

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

9-9: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In README.md around lines 8-9 (and also lines 279-283), there are bare URLs
causing MD034 lint errors; replace each raw URL with proper Markdown link syntax
by wrapping the link text in square brackets and the URL in parentheses (e.g.,
[link text](https://...)), updating the Note and any citation lines to use
descriptive link text rather than the bare URL so the markdown linter no longer
flags MD034.

Comment thread README.md
Comment on lines 58 to 64
Built on the [RD-CDM](https://rarelink.readthedocs.io/en/latest/1_background/1_5_rd_cdm.html),
all RareLink-CDM pipelines are preconfigured to generate FHIR resources compliant
with the [HL7 International Patient Summary](https://build.fhir.org/ig/HL7/fhir-ips/)
, [HL7 Genomics Reporting profiles](https://build.fhir.org/ig/HL7/genomics-reporting/)
or validated GA4GH Phenopackets. For disease-specific extensions, detailed guides
are available to help you develop sheets that integrate seamlessly with the
RareLink framework.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Reflow the stray comma/newline before the Genomics Reporting link (renders awkwardly).

 Built on the [RD-CDM](https://rarelink.readthedocs.io/en/latest/1_background/1_5_rd_cdm.html), 
 all RareLink-CDM pipelines are preconfigured to generate FHIR resources compliant
 with the [HL7 International Patient Summary](https://build.fhir.org/ig/HL7/fhir-ips/) 
-, [HL7 Genomics Reporting profiles](https://build.fhir.org/ig/HL7/genomics-reporting/) 
+, [HL7 Genomics Reporting profiles](https://build.fhir.org/ig/HL7/genomics-reporting/)
 or validated GA4GH Phenopackets.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Built on the [RD-CDM](https://rarelink.readthedocs.io/en/latest/1_background/1_5_rd_cdm.html),
all RareLink-CDM pipelines are preconfigured to generate FHIR resources compliant
with the [HL7 International Patient Summary](https://build.fhir.org/ig/HL7/fhir-ips/)
, [HL7 Genomics Reporting profiles](https://build.fhir.org/ig/HL7/genomics-reporting/)
or validated GA4GH Phenopackets. For disease-specific extensions, detailed guides
are available to help you develop sheets that integrate seamlessly with the
RareLink framework.
Built on the [RD-CDM](https://rarelink.readthedocs.io/en/latest/1_background/1_5_rd_cdm.html),
all RareLink-CDM pipelines are preconfigured to generate FHIR resources compliant
with the [HL7 International Patient Summary](https://build.fhir.org/ig/HL7/fhir-ips/),
[HL7 Genomics Reporting profiles](https://build.fhir.org/ig/HL7/genomics-reporting/)
or validated GA4GH Phenopackets. For disease-specific extensions, detailed guides
are available to help you develop sheets that integrate seamlessly with the
RareLink framework.
🤖 Prompt for AI Agents
In README.md around lines 58 to 64, the sentence has a stray comma and newline
before the "HL7 Genomics Reporting profiles" link which breaks flow and renders
awkwardly; reflow the sentence so the comma is correctly placed immediately
after the preceding link or removed as appropriate, keep the two FHIR links on
the same logical sentence (no unintended line break), and ensure
spacing/punctuation is correct (no orphaned commas or leading spaces before
links).

@aslgraefe
aslgraefe merged commit b5040bc into develop Dec 12, 2025
3 checks passed
@aslgraefe
aslgraefe deleted the 194-release205 branch December 12, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release/2.0.5

1 participant