docs(quickstart): add live demo tab - #562
Conversation
📝 WalkthroughWalkthroughThe Quick Start installation instructions now render provider credential guidance across platform tabs and add a Live Demo tab linking to the demo admin dashboard. ChangesQuick Start Installation Guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Confidence Score: 5/5Safe to merge with minimal risk. The change is limited to a single Mintlify navbar entry and does not affect runtime application behavior. No files require special attention.
What T-Rex did
Reviews (1): Last reviewed commit: "docs(navigation): add live demo link" | Re-trigger Greptile |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/getting-started/quickstart.mdx`:
- Around line 41-43: Update the Warning text in the quickstart documentation to
explicitly prohibit both sensitive and personal data, using the wording “Do not
enter sensitive or personal data.”
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 75465920-7f73-49f6-999c-846c50890e42
📒 Files selected for processing (1)
docs/getting-started/quickstart.mdx
| <Warning> | ||
| Do not enter sensitive data. Demo data is reset regularly. | ||
| </Warning> |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Also prohibit personal data.
Because this is a public dashboard, match the application’s policy and say “Do not enter sensitive or personal data.” “Sensitive data” alone may lead users to enter names, emails, or other personal information.
🤖 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 `@docs/getting-started/quickstart.mdx` around lines 41 - 43, Update the Warning
text in the quickstart documentation to explicitly prohibit both sensitive and
personal data, using the wording “Do not enter sensitive or personal data.”
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/getting-started/quickstart.mdx`:
- Around line 46-48: Update the “Live Demo” tab in the quickstart documentation
to add a clear warning not to enter sensitive, personal, or real API-key data,
because the linked dashboard is public.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: b8eb67ea-f125-40d3-b95b-6072aa15b996
📒 Files selected for processing (2)
docs/getting-started/quickstart.mdxdocs/snippets/provider-credentials-note.mdx
| <Tab title="Live Demo" icon="monitor-play"> | ||
| [https://demo.enterpilot.io/admin/dashboard](https://demo.enterpilot.io/admin/dashboard) | ||
| </Tab> |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Add a warning against entering sensitive or personal data.
Because this Live Demo links directly to a public dashboard, please explicitly warn users against entering sensitive or personal data to prevent the accidental exposure of PII or actual API keys.
🔒 Proposed fix
<Tab title="Live Demo" icon="monitor-play">
[https://demo.enterpilot.io/admin/dashboard](https://demo.enterpilot.io/admin/dashboard)
+
+ <Warning>Do not enter sensitive or personal data.</Warning>
</Tab>🤖 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 `@docs/getting-started/quickstart.mdx` around lines 46 - 48, Update the “Live
Demo” tab in the quickstart documentation to add a clear warning not to enter
sensitive, personal, or real API-key data, because the linked dashboard is
public.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Summary
Validation
mint validatemint broken-linksSummary by CodeRabbit