Skip to content

add how to get started with ODC doc#1388

Merged
joshunrau merged 2 commits into
DouglasNeuroInformatics:mainfrom
joshunrau:dev
Jun 25, 2026
Merged

add how to get started with ODC doc#1388
joshunrau merged 2 commits into
DouglasNeuroInformatics:mainfrom
joshunrau:dev

Conversation

@joshunrau

@joshunrau joshunrau commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added a new getting-started guide for ODC users.
    • Covers first-time login requirements, account-based navigation, group setup, starting a session, and common workflows like instrument administration, data review/export, CSV uploads, and assignments.
    • Includes guidance on when to contact an administrator and a troubleshooting checklist for missing options or unexpected data.

@joshunrau joshunrau merged commit 38f3f36 into DouglasNeuroInformatics:main Jun 25, 2026
1 of 2 checks passed
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: a1d66287-7c18-4bf9-9074-a78a9380201e

📥 Commits

Reviewing files that changed from the base of the PR and between ce831d2 and 797b1ab.

📒 Files selected for processing (1)
  • docs/en/3-guides/3.4-how-to-get-started-with-odc.mdx

Walkthrough

Adds a new getting-started guide for ODC that covers roles, prerequisites, group and session setup, common task entry points, admin escalation, and troubleshooting.

Changes

ODC getting-started guide

Layer / File(s) Summary
Onboarding context
docs/en/3-guides/3.4-how-to-get-started-with-odc.mdx
Frontmatter, imports, instance definition, ODC roles, prerequisites, and permission-driven navigation are added.
Group and session setup
docs/en/3-guides/3.4-how-to-get-started-with-odc.mdx
Group selection, Manage Group configuration, and the Start Session flow with subject identification and active-session behavior are documented.
Task entry points
docs/en/3-guides/3.4-how-to-get-started-with-odc.mdx
Accessible Instruments, Data Hub review/export, CSV upload, and Assignments access are described.
Support and troubleshooting
docs/en/3-guides/3.4-how-to-get-started-with-odc.mdx
Admin escalation cases and troubleshooting checks for missing features, instruments, and selections are added.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: private package registry requires authentication. Disable ESLint in CodeRabbit settings or use public packages.


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.

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.

1 participant