docs(migration): update NeoDash guide with corpus-tested findings - #883
Conversation
Refresh the migration guide based on a real-world validation pass against the OpenStudyBuilder NeoDash corpus (17 dashboards · 12-46 widgets each). - Chart type mapping table: add `text → markdown`, `circle_packing`/ `circlePacking → circle-packing`, both `iframe`/`iFrame` casings, `choropleth`/`areamap` aliases, `graph3d`/`3d-graph` (2D render), `gantt`. Reflects #878. - New 'Click actions' section: documents both the object-shape and string-shape ('set variable' + customizationValue) NeoDash emits. Reflects #881. - New 'Conditional / rule-based styling' section: explicit operator mapping table for styleRules. - New 'Auto-refresh' section: refreshRate (seconds) → cacheTtlMinutes. - New 'Known limitations' section with the one residual gap surfaced by testing: only the first actionsRules rule per widget is converted (tracked in #882). - Troubleshooting refreshed: schema-update files that aren't dashboards, text-widget JSON-fallback bug, click-action multi-rule limitation, silent auto-save bug. - Tip at top points to the corpus and links to Known limitations. No code changes. CI will validate the MDX build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughDocumentation update to the NeoDash→NeoBoard migration guide adding an importer validation callout, expanded widget type mappings and aliases, detailed conversion rules for click actions, conditional styling, and auto-refresh, plus expanded troubleshooting and known limitations. ChangesNeoDash Migration Documentation
🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/src/content/docs/getting-started/migration-from-neodash.mdx`:
- Line 170: The wording incorrectly states that refreshRate is "rounded up";
update the docs to say cacheTtlMinutes is derived by rounding to the nearest
minute using Math.round and then clamped to a minimum of 1 minute. Reference the
conversion from refreshRate to cacheTtlMinutes and mention Math.round and the
minimum-1 clamp so readers understand the exact behavior.
- Line 164: The doc line "Rules without a `color` value are dropped during
import — NeoBoard requires a color per rule." is incorrect because the current
converter defaults missing colors to "`#000000`" and retains those rules; update
that sentence to reflect actual behavior (e.g., "Rules without a `color` value
are retained — the converter defaults missing colors to `#000000`") or, if you
prefer to change runtime behavior instead, modify the import converter to drop
rules when `color` is missing; reference the documented sentence and the
converter behavior when making the change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 01ee60bf-25a4-4092-9a8f-4df6ce04d9a6
📒 Files selected for processing (1)
docs/src/content/docs/getting-started/migration-from-neodash.mdx
- Styling rules: the converter defaults missing colors to #000000 (black), it doesn't drop the rule. Updated wording to reflect the actual fallback behavior. - Auto-refresh: refreshRate→cacheTtlMinutes uses Math.round (nearest), not round-up. Show the exact formula plus concrete examples (30s→1m, 90s→2m, 300s→5m). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Summary
Refresh `getting-started/migration-from-neodash.mdx` based on a real-world validation pass against the OpenStudyBuilder NeoDash corpus — 17 dashboards, 12-46 widgets each, heavy use of parameters/click actions/styling.
Sections added
Sections refined
Companion work this session
Test plan
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
Summary by CodeRabbit