Skip to content

Update documentation for analysis creation - #107

Merged
SirHerr merged 4 commits into
PrivateAIM:masterfrom
marlenamey:create-analysis-update
Aug 7, 2026
Merged

Update documentation for analysis creation#107
SirHerr merged 4 commits into
PrivateAIM:masterfrom
marlenamey:create-analysis-update

Conversation

@marlenamey

@marlenamey marlenamey commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

basiert auf PR #106

Summary by CodeRabbit

  • New Features
    • Added a Demo Instance route with guidance for creating projects, configuring data stores, connecting data, and running the HALTA demo analysis.
  • Documentation
    • Added installation verification steps using a demo analysis.
    • Restructured the analysis guide with clearer navigation and wizard configuration steps.
    • Clarified build, distribution, approval, execution, and result-download workflows.
    • Added guidance for developing custom analyses, including links to demo data and supporting documentation.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 63547adb-25ed-4f0b-b7cb-32694f71d1db

📥 Commits

Reviewing files that changed from the base of the PR and between df70423 and 14402e6.

📒 Files selected for processing (2)
  • src/guide/user/analysis.md
  • src/guide/user/demo.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/guide/user/analysis.md

📝 Walkthrough

Walkthrough

The documentation adds a demo-instance guide, updates installation verification, revises the analysis workflow, and changes user sidebar routes.

Changes

Documentation workflows

Layer / File(s) Summary
Analysis workflow documentation
src/guide/user/analysis.md
The guide updates project navigation, analysis creation, wizard configuration, build and distribution steps, execution, approval, and result retrieval.
Demo setup and installation verification
src/guide/user/demo.md, src/guide/deployment/node-installation.md
The new demo guide documents project setup, data-store connectivity, demo analysis execution, and custom analysis development. Installation guidance links to the demo workflow.
Sidebar navigation updates
src/.vitepress/routes/sidebar/user.ts
The sidebar reformats Analysis Coding and Local Testing entries, adds the FHIR Queries route, and adds the Demo Instance route.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: updating documentation for analysis creation and related workflows.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/guide/user/analysis.md`:
- Around line 22-35: Update the documentation around the “Approval,” “Build
Analysis,” “Distribute Analysis,” and “Execution” sections to make approval an
explicit prerequisite before building, either by moving the Approval section
before Step 4 or clearly labeling it as a prerequisite. Revise the Execution
text to state that nodes can start only after approval, a successful build, and
distribution.

In `@src/guide/user/demo.md`:
- Around line 1-19: Remove the Markdown comment-syntax scratchpad at the start
of the guide, including the HTML comment and all reference-definition examples,
so the document begins with Demo Instance workflow content; do not replace it
with unrelated documentation.
- Line 81: Remove the stale TODO comment in the documentation near the
analysis.md reference, since src/guide/user/analysis.md has been updated. Do not
replace it unless there is a specific current, actionable task to record.
- Around line 50-53: Update the preparation step heading and description around
the project workflow so they match the sidebar’s “Submitting a Project Proposal”
terminology and state that a proposal is required before creating an analysis.
Keep the link aligned with the documented proposal-submission workflow, or
explicitly explain when the project becomes available for analysis.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5baa19f4-bccf-4158-80dd-45b18f47f80c

📥 Commits

Reviewing files that changed from the base of the PR and between be7086e and 09ebdd4.

⛔ Files ignored due to path filters (3)
  • src/public/images/ui_images/analysis_distribution.png is excluded by !**/*.png
  • src/public/images/ui_images/analysis_start.png is excluded by !**/*.png
  • src/public/images/ui_images/hub_add_analysis_from_proposal.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • src/.vitepress/routes/sidebar/user.ts
  • src/guide/deployment/node-installation.md
  • src/guide/user/analysis.md
  • src/guide/user/demo.md

Comment thread src/guide/user/analysis.md
Comment thread src/guide/user/demo.md Outdated
Comment thread src/guide/user/demo.md Outdated
Comment thread src/guide/user/demo.md
@SirHerr
SirHerr merged commit 5726a73 into PrivateAIM:master Aug 7, 2026
2 checks passed
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.

3 participants