Skip to content

docs(quickstart): add live demo tab - #562

Merged
SantiagoDePolonia merged 4 commits into
mainfrom
docs/live-demo-link
Jul 20, 2026
Merged

docs(quickstart): add live demo tab#562
SantiagoDePolonia merged 4 commits into
mainfrom
docs/live-demo-link

Conversation

@SantiagoDePolonia

@SantiagoDePolonia SantiagoDePolonia commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a Live Demo link to the documentation navbar
  • link directly to the public GoModel dashboard

Validation

  • mint validate
  • mint broken-links
  • live demo endpoint returns HTTP 200

Summary by CodeRabbit

  • Documentation
    • Updated the Quick Start platform setup instructions to include an AI-generated provider credentials note under macOS/Linux, Windows, and Docker tabs.
    • Added a new “Live Demo” tab to Quick Start that links to the demo admin dashboard.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The Quick Start installation instructions now render provider credential guidance across platform tabs and add a Live Demo tab linking to the demo admin dashboard.

Changes

Quick Start Installation Guidance

Layer / File(s) Summary
Provider configuration note and installation integration
docs/snippets/provider-credentials-note.mdx, docs/getting-started/quickstart.mdx
Adds a reusable note describing required provider credentials or base URLs and renders it in the macOS/Linux, Windows, and Docker installation tabs. The tab set also includes a Live Demo dashboard link.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • ENTERPILOT/GoModel#62: Updates quick-start documentation with provider credential and base URL guidance.

Poem

A bunny hops through tabs with care,
Provider keys are noted there.
Docker, Windows, macOS too,
A live demo waits for you.
Quick-start carrots everywhere!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately reflects the main docs change: adding a Live Demo tab to the quickstart.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/live-demo-link

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gomodel 🟢 Ready View Preview Jul 20, 2026, 1:53 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@greptile-apps

greptile-apps Bot commented Jul 20, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

Safe 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.

T-Rex T-Rex Logs

What T-Rex did

  • I ran Mintlify validation, performed a broken-link check, and verified HTTP status codes, capturing command output with the working directory and exit codes.
  • I saved a small helper shell script used for the endpoint assertion to support the HTTP status verification.
  • I prepared and saved artifacts that include the command outputs and the endpoint assertion helper script for review.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs(navigation): add live demo link" | Re-trigger Greptile

@SantiagoDePolonia SantiagoDePolonia changed the title docs(navigation): add live demo link docs(quickstart): add live demo tab Jul 20, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 03013a9 and 1e21dd5.

📒 Files selected for processing (1)
  • docs/getting-started/quickstart.mdx

Comment thread docs/getting-started/quickstart.mdx Outdated
Comment on lines +41 to +43
<Warning>
Do not enter sensitive data. Demo data is reset regularly.
</Warning>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 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.”

@SantiagoDePolonia
SantiagoDePolonia merged commit 44ce16f into main Jul 20, 2026
19 of 20 checks passed

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1e21dd5 and 4436988.

📒 Files selected for processing (2)
  • docs/getting-started/quickstart.mdx
  • docs/snippets/provider-credentials-note.mdx

Comment on lines +46 to 48
<Tab title="Live Demo" icon="monitor-play">
[https://demo.enterpilot.io/admin/dashboard](https://demo.enterpilot.io/admin/dashboard)
</Tab>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 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.

@mintlify

mintlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gomodel 🟡 Building Jul 20, 2026, 1:52 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants