Conversation
- Introduced meta.json for the Study Configurator with title and description. - Created study-variables.mdx to document study variables, their management, and use cases. - Added images for study variables configuration and management.
- Clarified the role of study variables in providing dynamic global behavior. - Expanded the "Using Study Variables" section to include specific applications for study rules and survey conditions. - Added notes on expressions and actions related to study variables.
WalkthroughAdds a new Study Configurator docs section: a metadata file ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolcontent/docs/study-configurator/study-variables.mdx[grammar] ~6-~6: There might be a mistake here. (QB_NEW_EN) [grammar] ~9-~9: There might be a mistake here. (QB_NEW_EN) [grammar] ~15-~15: There might be a mistake here. (QB_NEW_EN) [grammar] ~16-~16: Use a hyphen to join words. (QB_NEW_EN_HYPHEN) [grammar] ~18-~18: There might be a mistake here. (QB_NEW_EN) [grammar] ~19-~19: There might be a mistake here. (QB_NEW_EN) [grammar] ~20-~20: There might be a mistake here. (QB_NEW_EN) [grammar] ~21-~21: There might be a mistake here. (QB_NEW_EN) [grammar] ~22-~22: There might be a mistake here. (QB_NEW_EN) [grammar] ~31-~31: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~31-~31: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~104-~104: There might be a mistake here. (QB_NEW_EN) [grammar] ~105-~105: There might be a mistake here. (QB_NEW_EN) [grammar] ~114-~114: There might be a mistake here. (QB_NEW_EN) [grammar] ~118-~118: There might be a mistake here. (QB_NEW_EN) [grammar] ~123-~123: There might be a mistake here. (QB_NEW_EN) 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
content/docs/study-configurator/study-variables.mdx (7)
15-17: Tighten wording and fix hyphenation/consistency.Small grammar/consistency nits (optional):
- Use American English consistently (“individualized” vs “individualised”).
- Hyphenate “cohort‑specific” and avoid the spaced slash.
-While the "participant flags" provide a way for individualised logic, study variables provide a simple way for dynamic "global" (study/ cohort specific) behavior. +While "participant flags" provide a way for individualized logic, study variables provide a simple way to control dynamic “global” (study‑ or cohort‑specific) behavior.
25-27: Fix agreement and clarity.Improve subject–verb agreement and clarity:
-Studies can have its own set of study variables. The study administrator can manage (create, edit value or configuration, delete) study variables. +Each study can have its own set of study variables. The study administrator can manage them (create, edit value or configuration, delete).
63-64: Value type list consistency (optional).For consistency, either capitalize all types or format as code literals:
-Select the value type of the study variable. (string, integer, float, boolean, date) +Select the value type of the study variable (String, Integer, Float, Boolean, Date).Or:
-Select the value type of the study variable. (string, integer, float, boolean, date) +Select the value type of the study variable (`string`, `integer`, `float`, `boolean`, `date`).
90-91: Hyphenate “Type‑specific”.-Type specific configuration for the study variable, depending on the value type. For example, for numbers and dates you can define a minimum and maximum value. For strings, you can define if a select with options should be used or if a text input should be used. +Type‑specific configuration for the study variable, depending on the value type. For example, for numbers and dates you can define minimum and maximum values. For strings, you can choose between a select with options or a text input.
118-121: Replace TODOs with links or tracking issue.The placeholders “(todo: link)” should be resolved or tracked.
I can add the correct links or insert a reference to a tracking issue if links aren’t ready yet.
18-24: Minor list polish (optional).Consider making type names consistent and concise:
-- String -- Number, more specifically: integer or float -- Boolean -- Date +- String +- Number (integer or float) +- Boolean +- Date
112-117: Scope clarity (optional).Earlier you mention “study/ cohort‑specific.” Consider briefly clarifying scoping here (e.g., whether variables can be defined at study level, cohort level, and precedence rules when both exist).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
content/docs/study-configurator/images/study-variables-empty.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/study-variables-with-entries.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/variable-config-1.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/variable-config-2.pngis excluded by!**/*.png
📒 Files selected for processing (2)
content/docs/study-configurator/meta.json(1 hunks)content/docs/study-configurator/study-variables.mdx(1 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] ~9-~9: There might be a mistake here.
Context: ...g from './images/variable-config-1.png'; import studyVariablesConfig2Img from './...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...hange the study rules or questionnaires. While the "participant flags" provide a ...
(QB_NEW_EN)
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... way for dynamic "global" (study/ cohort specific) behavior. A study variable ha...
(QB_NEW_EN_HYPHEN)
[grammar] ~18-~18: 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] ~19-~19: There might be a mistake here.
Context: ... value type can be one of the following: - String - Number, more specifically: inte...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...pe can be one of the following: - String - Number, more specifically: integer or fl...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...ber, more specifically: integer or float - Boolean - Date Studies can have its own...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...specifically: integer or float - Boolean - Date Studies can have its own set of st...
(QB_NEW_EN)
[grammar] ~31-~31: Ensure spelling is correct
Context: ...ropdown to change the study flow (e.g., phase1 -> phase2, with different behavior for ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~31-~31: Ensure spelling is correct
Context: ... change the study flow (e.g., phase1 -> phase2, with different behavior for each phase...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~104-~104: There might be a mistake here.
Context: ..., a datepicker or a text / number input. - To edit the "configuration" of a study v...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...e's card, and select "Edit configs". - To delete a study variable, use the thre...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...les can be used in the following places: - Study rules / study actions (server-si...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...vailable study expressions: (todo: link) - Survey conditions (client-side): -...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...vailable if the application supports it.
(QB_NEW_EN)
🔇 Additional comments (1)
content/docs/study-configurator/meta.json (1)
1-5: Confirm single-root usage for this section."root": true can conflict if multiple pages in the same section declare root. Please verify only one root exists under content/docs/study-configurator or the site’s docs root config.
- Updated description to specify "study specific" behavior instead of "study/cohort specific." - Corrected image caption to accurately reflect the content of the displayed example.
- Enhanced descriptions for better readability and understanding of study variables. - Updated terminology for consistency and precision, including value type formatting. - Clarified management capabilities of study variables for administrators.
1 participant
Summary by CodeRabbit