Skip to content

Study counters#20

Merged
phev8 merged 3 commits intomainfrom
study-counters
Oct 16, 2025
Merged

Study counters#20
phev8 merged 3 commits intomainfrom
study-counters

Conversation

@phev8
Copy link
Copy Markdown
Contributor

@phev8 phev8 commented Oct 16, 2025

Summary by CodeRabbit

  • Documentation
    • Renamed and expanded "Study Variables" to "Study Variables and Counters" with clearer sectioning.
    • Added visual preview and enhanced introduction content.
    • Simplified value type listing to concise code-style terms (string, integer, float, boolean, date).
    • Introduced a new Counters section with usage examples and management guidance.
    • Added illustrations for managing counters and variables.

phev8 added 2 commits October 16, 2025 12:53
- Updated title and description for clarity.
- Added a new section on study counters, including their purpose and usage.
- Improved formatting of value types for better readability.
- Included examples of counter use cases to illustrate practical applications.
- Introduced a new section detailing the management of study counters, including features for viewing, initializing, changing, and deleting counters.
- Added an illustrative image to enhance understanding of the counter management interface.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 16, 2025

Walkthrough

Documentation page expanded to cover both study variables and counters; added a preview block and explicit Introduction header, reformatted value types to code style, imported TypeTable UI component, added Counters and Managing Counters sections with examples and images, and removed an empty image block.

Changes

Cohort / File(s) Summary
Docs: study variables + counters
content/docs/study-configurator/study-variables.mdx
Title and description updated to include "Counters". Added preview image block and explicit Introduction header. Imported TypeTable from fumadocs-ui/components/type-table. Reformatted Study Variable value types to code list: string, integer, float, boolean, date. Added new "Counters" section with TypeTable usage, example use cases, and a "Managing Counters" section with an image. Removed an empty image block previously under Managing Study Variables.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 A page grew new leaves, neat rows and new flares,
Counters and variables hopping through pairs.
TypeTables align them, tidy and bright,
Docs nibble along under soft lantern light. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Study counters" is directly related to the main changes in the pull request. The raw summary shows that the primary new content added is a Counters section with a Managing Counters subsection, along with example usage and visual illustrations. The title clearly and specifically identifies that this PR introduces counters documentation, which aligns with the substantial new content being added to the file. The title is concise, avoids vague terms, and a teammate scanning the history would understand that this PR adds or documents study counters functionality.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch study-counters

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e95ed43 and e3ff417.

⛔ Files ignored due to path filters (3)
  • content/docs/study-configurator/images/study-counters.png is excluded by !**/*.png
  • content/docs/study-configurator/images/study-variables-empty.png is excluded by !**/*.png
  • content/docs/study-configurator/images/study-variables-with-entries.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • content/docs/study-configurator/study-variables.mdx (3 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/study-configurator/study-variables.mdx

[grammar] ~6-~6: There might be a mistake here.
Context: ...rom 'fumadocs-ui/components/image-zoom'; import { Step, Steps } from 'fumadocs-ui...

(QB_NEW_EN)


[grammar] ~7-~7: There might be a mistake here.
Context: ...s } from 'fumadocs-ui/components/steps'; import { TypeTable } from 'fumadocs-ui/c...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...g from './images/variable-config-1.png'; import studyVariablesConfig2Img from './...

(QB_NEW_EN)


[grammar] ~20-~20: There might be a mistake here.
Context: ...> ## Introduction ### Study Variables Study variables add the capability for s...

(QB_NEW_EN)


[grammar] ~21-~21: There might be a mistake here.
Context: ...hange the study rules or questionnaires. While "participant flags" provide a way ...

(QB_NEW_EN)


[grammar] ~22-~22: Use a hyphen to join words.
Context: ...e way to control dynamic “global” (study specific) behavior. A study variable ha...

(QB_NEW_EN_HYPHEN)


[grammar] ~24-~24: There might be a mistake here.
Context: ...in the study), a value and a value type. The value type can be one of the followi...

(QB_NEW_EN)


[grammar] ~42-~42: There might be a mistake here.
Context: ...e counter within the study. <TypeTable type={{ scope: { description: ...

(QB_NEW_EN)


[grammar] ~54-~54: There might be a mistake here.
Context: ...nteger', default: '0', }, }} /> Counters can be used to track diffe...

(QB_NEW_EN)


[grammar] ~155-~155: There might be a mistake here.
Context: ...ly supported are the following features: - View all counters with their scope key a...

(QB_NEW_EN)

Comment thread content/docs/study-configurator/study-variables.mdx
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (1)
content/docs/study-configurator/study-variables.mdx (1)

161-163: Provide descriptive alt text for the counters screenshot.

Line 162 still uses the vague alt text “Study counters view.” Screen-reader users need context about what the image conveys (e.g., counters list, current values, controls). Please update it to a concise, descriptive phrase that reflects the counter-management UI.

-![Study counters view](./images/study-counters.png)
+![Counter management view showing counters list, current values, and controls](./images/study-counters.png)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e3ff417 and 4c1631f.

📒 Files selected for processing (1)
  • content/docs/study-configurator/study-variables.mdx (3 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/study-configurator/study-variables.mdx

[grammar] ~6-~6: There might be a mistake here.
Context: ...rom 'fumadocs-ui/components/image-zoom'; import { Step, Steps } from 'fumadocs-ui...

(QB_NEW_EN)


[grammar] ~7-~7: There might be a mistake here.
Context: ...s } from 'fumadocs-ui/components/steps'; import { TypeTable } from 'fumadocs-ui/c...

(QB_NEW_EN)


[grammar] ~10-~10: There might be a mistake here.
Context: ...g from './images/variable-config-1.png'; import studyVariablesConfig2Img from './...

(QB_NEW_EN)


[grammar] ~20-~20: There might be a mistake here.
Context: ...> ## Introduction ### Study Variables Study variables add the capability for s...

(QB_NEW_EN)


[grammar] ~21-~21: There might be a mistake here.
Context: ...hange the study rules or questionnaires. While "participant flags" provide a way ...

(QB_NEW_EN)


[grammar] ~22-~22: Use a hyphen to join words.
Context: ...e way to control dynamic “global” (study specific) behavior. A study variable ha...

(QB_NEW_EN_HYPHEN)


[grammar] ~24-~24: There might be a mistake here.
Context: ...in the study), a value and a value type. The value type can be one of the followi...

(QB_NEW_EN)


[grammar] ~42-~42: There might be a mistake here.
Context: ...e counter within the study. <TypeTable type={{ scope: { description: ...

(QB_NEW_EN)


[grammar] ~54-~54: There might be a mistake here.
Context: ...nteger', default: '0', }, }} /> Counters can be used to track diffe...

(QB_NEW_EN)


[grammar] ~155-~155: There might be a mistake here.
Context: ...ly supported are the following features: - View all counters with their scope key a...

(QB_NEW_EN)

Comment thread content/docs/study-configurator/study-variables.mdx
@phev8 phev8 merged commit 1767493 into main Oct 16, 2025
1 check passed
@phev8 phev8 deleted the study-counters branch October 16, 2025 11:36
@coderabbitai coderabbitai Bot mentioned this pull request Oct 17, 2025
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