Lead the VS Code quick start with the setup wizard

[GuanzhouSong]

Why

The guide described only the manual flow: start the container yourself, then create a New Local Connection and disable TLS. It never mentioned the setup wizard the extension has shipped since v0.10.0, which pulls the image, starts the container, waits for readiness, and saves the connection for you.

That matters now because documentdb.github.io#179 adds a VS Code tab to the homepage quick start that points people at exactly that wizard, and links here for the full guide. Without this change the journey is: homepage promises a guided setup → reader opens this page → the page tells them to run Docker by hand and fill in a connection form. The two contradict each other.

What changed

Lead with Set Up DocumentDB Local and give all three ways to open it: the Connections view, the Command Palette, and the deep link.

The manual flow stays as Alternative: Connect to a Container You Started Yourself, for people who already run the container or want to manage it themselves. Its commands and notes are unchanged from #75 — the loopback binding, the credential prompts and empty-value rejection, and the Linux Foundation, credentials, network, and port notes are all preserved. I verified the bash and PowerShell blocks are byte-identical to main.

Also in this pass:

• The Docker prerequisite now says Docker must be reachable from the environment VS Code runs in, which is the part that actually bites people in WSL, dev containers, SSH remotes, and Codespaces.
• Dropped the Git installed (for cloning the repository) prerequisite; nothing in this guide clones a repository.
• Setup now states what you get: the container name, the persistent volume, generated credentials, and the sampledb collections.
• Creating databases and collections moved out of the manual path into its own section, since both paths need it.
• Replaced the empty Common issues and solutions and Using the extension logs stubs — they were headings with no content — with the two failures people actually hit and where the logs live.

Verification

Every wizard-facing claim was checked against microsoft/vscode-documentdb main (013e429f), reading source rather than release notes:

Claim	Source
Wizard steps and button labels	LocalQuickStart.tsx — introduction → Continue → configure → Start DocumentDB Local → Open Connection
Command Palette title	package.json contributes Set up DocumentDB Local under category DocumentDB
Deep link route and its confirmation prompt	vscodeUriHandler.ts — /local is shorthand for /local/documentdb
Container name, volume, port 10260, sampledb	services/localQuickStart/quickStartTypes.ts, QuickStartService.ts
Tree entry point Your own DocumentDB	tree/connections-view/LocalQuickStart/LocalQuickStartItem.ts
Linux containers readiness state	webviews/documentdb/localQuickStart/dockerReadinessPresentation.ts

The 0.10.1 or later note on the deep link is the release that shipped it (v0.10.1), still the latest published release.

One rendering detail: the deep link is inline code rather than a link because documentdb.io renders these files with react-markdown (no rehype-raw, default URL sanitization), which strips both raw anchors and non-http(s) hrefs. A vscode:// link would render dead on the site.

Not verified

The wizard flow was not exercised end to end in VS Code for this change; the steps are read from extension source and its released tag.

🤖 Generated with Claude Code

https://claude.ai/code/session_017dU6YABKoUxKLU2AB1qeH1