@beaconlabs-io/evidence 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -154,8 +154,8 @@ title: "Effect of X on Y"
154
154
  author: "BeaconLabs"
155
155
  date: "2024-01-01"
156
156
  results:
157
- - intervention: "Description of intervention"
158
- outcome_variable: "What was measured"
157
+ - intervention: "Description of intervention" # max 80 chars
158
+ outcome_variable: "What was measured" # max 50 chars
159
159
  outcome: "+" # N/A, +, -, +-, !
160
160
  strength: "3" # 0-5 (Maryland SMS scale)
161
161
  methodologies:
@@ -178,6 +178,17 @@ datasets:
178
178
  ## Background
179
179
  ```
180
180
 
181
+ ### Field Length Limits
182
+
183
+ | Field | Max Length | Description |
184
+ | ------------------ | ---------- | ------------------------------ |
185
+ | `title` | 200 chars | Research title |
186
+ | `author` | 100 chars | Author name |
187
+ | `intervention` | 80 chars | Brief description of treatment |
188
+ | `outcome_variable` | 50 chars | Measured variable name |
189
+
190
+ > **Note:** Keep frontmatter fields concise. Detailed explanations belong in the MDX body content.
191
+
181
192
  ### Outcome Effects
182
193
 
183
194
  | Value | Meaning |