feat: first version of demo instance chapter - #106
Conversation
📝 WalkthroughWalkthroughAdds a Demo Instance guide covering project setup, data connection, and analysis execution. Links it from the user sidebar and adds node installation verification instructions referencing the demo workflow. ChangesDemo Instance onboarding
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/.vitepress/routes/sidebar/user.tsESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. 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 (1)
src/guide/user/demo.md (1)
1-19: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winRemove the comment-syntax examples from the published guide.
These lines are unrelated to the Demo Instance workflow and trigger the reported unused/duplicate Markdown reference warnings. Keep this page focused on the user workflow.
🤖 Prompt for 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. In `@src/guide/user/demo.md` around lines 1 - 19, Remove all comment-syntax example blocks from the guide page, including the HTML comment and Markdown reference-style examples shown in the diff. Leave the Demo Instance workflow content intact and ensure no unused or duplicate Markdown references remain.Source: Linters/SAST tools
🤖 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 `@src/guide/user/demo.md`:
- Line 53: Replace the generic “here” link labels in the demo guide, including
the references at the project, data-store bucket, data-store connections, and
analysis sections, with descriptive labels such as “Create a project,” “Set up a
data-store bucket,” “Manage data-store connections,” and “Create an analysis,”
while preserving the existing destinations.
- Around line 79-81: Resolve the outdated analysis prerequisite referenced by
the guide: either update the linked analysis documentation at the `./analysis`
target with current content, or replace the link with accurate analysis-creation
steps in `demo.md`; remove the TODO indicating known-stale documentation before
publishing.
---
Nitpick comments:
In `@src/guide/user/demo.md`:
- Around line 1-19: Remove all comment-syntax example blocks from the guide
page, including the HTML comment and Markdown reference-style examples shown in
the diff. Leave the Demo Instance workflow content intact and ensure no unused
or duplicate Markdown references remain.
🪄 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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 68723226-e029-4f4f-ad65-798d602b2adb
📒 Files selected for processing (3)
src/.vitepress/routes/sidebar/user.tssrc/guide/deployment/node-installation.mdsrc/guide/user/demo.md
| ### 1. Create a Project in the Hub | ||
|
|
||
| To run an analysis, a project must first be created in the Hub. A project defines the scope of the analysis, | ||
| including the target nodes, the requested data, and the images to be used. Creating a project is described in detail [here](./project). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Replace “here” with descriptive link labels.
Use labels such as “Create a project,” “Set up a data-store bucket,” “Manage data-store connections,” and “Create an analysis” so links remain understandable out of context.
Also applies to: 60-60, 72-72, 79-79
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 53-53: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for 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.
In `@src/guide/user/demo.md` at line 53, Replace the generic “here” link labels in
the demo guide, including the references at the project, data-store bucket,
data-store connections, and analysis sections, with descriptive labels such as
“Create a project,” “Set up a data-store bucket,” “Manage data-store
connections,” and “Create an analysis,” while preserving the existing
destinations.
Source: Linters/SAST tools
| target nodes, and the entrypoint for the analysis, and is described in detail [here](./analysis). | ||
|
|
||
| [//]: # (TODO: update analysis.md, its content is outdated) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Do not ship a known-outdated prerequisite link.
The workflow directs users to analysis.md while explicitly stating that its content is outdated. Update that page or provide the current analysis-creation steps here before publishing the end-to-end guide.
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 79-79: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for 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.
In `@src/guide/user/demo.md` around lines 79 - 81, Resolve the outdated analysis
prerequisite referenced by the guide: either update the linked analysis
documentation at the `./analysis` target with current content, or replace the
link with accurate analysis-creation steps in `demo.md`; remove the TODO
indicating known-stale documentation before publishing.
1 participant
Summary by CodeRabbit
New Features
Documentation