Conversation
…/deployment guides (#130) Add comprehensive documentation for Phase 3: - CLI reference: setup, init, install, docker commands with flags and examples - Client guides: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Roo Code - Deployment options: local stdio, Docker standalone, Docker+PostgreSQL, Docker Compose - Troubleshooting: connection, client, and Docker issues - Installation hub: wizard walkthrough, manual configuration guide - VitePress config: new sidebar sections and updated navigation - Cross-links in existing docs (quick-start, npm, docker, list-tools)
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Setup Wizard and CLI commands (Phase 3 of the documentation refactor), building on the VitePress foundation and the Unified Setup Wizard implementation.
Changes:
- Adds complete Setup Wizard documentation with interactive walkthrough, discovery phase, and mode selection guides
- Adds full CLI reference for all commands (setup, init, install, docker, list-tools) with detailed flags, examples, and exit codes
- Adds dedicated configuration guides for all 7 supported MCP clients with OS-specific paths
- Adds deployment documentation covering 4 options with architecture diagrams and management commands
- Adds comprehensive troubleshooting section covering connection, client, and Docker issues
- Updates VitePress navigation and sidebar with new Clients, Deployment, and Troubleshooting sections
- Cross-links existing documentation to new wizard and deployment guides
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/troubleshooting/index.md | Quick diagnosis table and general troubleshooting steps |
| docs/troubleshooting/connection.md | GitLab connection issues (tokens, scopes, URLs, timeouts) |
| docs/troubleshooting/clients.md | MCP client detection and configuration problems |
| docs/troubleshooting/docker.md | Docker container startup, networking, and database issues |
| docs/guide/quick-start.md | Added Setup Wizard recommendation and updated navigation links |
| docs/guide/installation/index.md | Installation methods overview and comparison table |
| docs/guide/installation/wizard.md | Complete Setup Wizard walkthrough with phases and flows |
| docs/guide/installation/manual.md | Manual configuration guide with alternatives |
| docs/guide/installation/npm.md | Added Setup Wizard tip |
| docs/guide/installation/docker.md | Added deployment documentation reference |
| docs/deployment/index.md | Deployment options comparison and decision guide |
| docs/deployment/local-stdio.md | Local stdio deployment guide with architecture diagram |
| docs/deployment/docker-standalone.md | Docker standalone deployment without persistence |
| docs/deployment/docker-postgres.md | Docker + PostgreSQL for OAuth persistence |
| docs/deployment/docker-compose.md | Complete Docker Compose setup with examples |
| docs/clients/index.md | Supported clients overview with config paths for all OS |
| docs/clients/claude-desktop.md | Claude Desktop configuration guide |
| docs/clients/claude-code.md | Claude Code CLI configuration |
| docs/clients/cursor.md | Cursor IDE configuration |
| docs/clients/vscode.md | VS Code + GitHub Copilot configuration |
| docs/clients/windsurf.md | Windsurf IDE configuration |
| docs/clients/cline.md | Cline VS Code extension configuration |
| docs/clients/roo-code.md | Roo Code configuration |
| docs/cli/index.md | CLI commands overview and usage |
| docs/cli/setup.md | Interactive setup wizard command reference |
| docs/cli/init.md | Local setup alias command |
| docs/cli/install.md | Client installation command with flags |
| docs/cli/docker.md | Docker management subcommands |
| docs/cli/list-tools.md | Updated title for consistency |
| docs/.vitepress/config.mts | Added navigation for Clients, Deployment, and Troubleshooting sections |
Replace insecure NODE_TLS_REJECT_UNAUTHORIZED=0 as the primary self-signed certificate solution with NODE_EXTRA_CA_CERTS which trusts only the specific CA while keeping TLS validation active.
polaz
deleted the
feat/#130-docs-setup-wizard-documentation-and-cli-reference
branch
|
🎉 This PR is included in version 6.37.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
setup,init,install,docker,list-toolswith flags, examples, and exit codesCloses #130
Test plan
yarn lint— 0 errorsyarn test— 3743 tests passedyarn docs:build— successful build (3.35s)yarn docs:dev