Skip to content

expand and improve instrument documentation#1286

Merged
joshunrau merged 4 commits intoDouglasNeuroInformatics:mainfrom
joshunrau:document-instrument-structure-in-detail
Feb 11, 2026
Merged

expand and improve instrument documentation#1286
joshunrau merged 4 commits intoDouglasNeuroInformatics:mainfrom
joshunrau:document-instrument-structure-in-detail

Conversation

@joshunrau
Copy link
Collaborator

@joshunrau joshunrau commented Feb 11, 2026

Summary by CodeRabbit

  • New Features

    • Added defineSeriesInstrument to the public runtime API.
  • Documentation

    • Enhanced documentation on instruments and runtime concepts with improved code examples and terminology clarifications.

@joshunrau joshunrau merged commit 405df7b into DouglasNeuroInformatics:main Feb 11, 2026
1 check failed
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation update to the instruments concept page introducing a top-level Overview section, restructuring content layout, correcting terminology ("tree-shaken"), clarifying runtime and bundling details, and documenting the newly added defineSeriesInstrument public API alongside defineInstrument.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/en/4-concepts/4.1-instruments.mdx
Content restructuring with new Overview section, terminology corrections ("tree shaken" → "tree-shaken"), API documentation introducing defineSeriesInstrument, clarified runtime/bundling mechanics, and refined code samples reflecting updated API usage.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

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