Skip to content

Add Tailscale connection instructions to quickstart page #3073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
+7 −0
Closed

Add Tailscale connection instructions to quickstart page #3073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added images/quickstart/tailscale-connection-instructions.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
---

<Frame>
<img
src="/images/quickstart/tailscale-connection-instructions.png"
alt="Tailscale connection instructions showing how to install Tailscale, connect to VPN, and access the exit node."
/>
</Frame>
Copy link

@cursor cursor bot Feb 3, 2026

Choose a reason for hiding this comment

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

Internal VPN instructions added to public user documentation

High Severity

Internal Tailscale VPN connection instructions were added to public-facing customer documentation. The quickstart.mdx file guides external users through deploying their documentation sites using Mintlify's public services. The PR description explicitly mentions these are instructions for connecting to "Mintlify organization's Tailscale VPN" - internal infrastructure that external customers don't need and shouldn't see. This appears to be internal employee onboarding content accidentally committed to public documentation.

Fix in Cursor Fix in Web


After you complete this guide, you'll have a live documentation site ready to customize and update.

## Before you begin
Expand All @@ -16,7 +23,7 @@

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

Check warning on line 26 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L26 

In general, use active voice instead of passive voice ('is deployed').

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -56,7 +63,7 @@
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

Check warning on line 66 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L66 

Spell out 'LTS', if it's unfamiliar to the audience.

<CodeGroup>

Expand Down Expand Up @@ -138,7 +145,7 @@
## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 148 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L148 

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
Expand Down
Loading