Enhancement/claude refactor docs#118
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request represents a comprehensive documentation restructuring for the HoloViz MCP project. The refactoring reorganizes the documentation to better support multiple AI assistant tools and installation methods, improving user experience by providing tailored guides for each platform.
Changes:
- Restructured getting-started tutorials by IDE/tool (Claude Code, Claude Desktop, Copilot+VS Code, Cursor, Windsurf)
- Split installation and configuration guides by method and tool for clearer navigation
- Consolidated display-related documentation (display-tool.md and display-server.md merged into display-system.md)
- Updated logo from SVG to PNG format
- Reorganized mkdocs navigation to reflect the new documentation structure
- Updated all internal cross-references to match the new file organization
Reviewed changes
Copilot reviewed 39 out of 42 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Restructured navigation to organize content by IDE/tool, split installation/configuration sections, changed logo reference from SVG to PNG |
| docs/index.md | Updated to highlight tool selection upfront, simplified documentation structure presentation |
| docs/tutorials/getting-started-*.md | Five new getting-started guides created, each tailored for a specific IDE/tool (Claude Code, Claude Desktop, Copilot+VS Code, Cursor, Windsurf) |
| docs/tutorials/stock-analysis-*.md | Split into tool-specific versions (copilot-vscode and claude-code) |
| docs/tutorials/weather-dashboard-*.md | Split into tool-specific versions and updated references |
| docs/tutorials/display-system.md | Consolidated display-tool.md and display-server.md into comprehensive display system tutorial |
| docs/how-to/install-*.md | Split installation guide into four method-specific guides (uv, pip, conda, docker) |
| docs/how-to/configure-*.md | Split IDE configuration into tool-specific guides (vscode, claude-desktop, claude-code, cursor, windsurf) |
| docs/how-to/configure-settings.md | Extracted general settings configuration from configuration.md |
| docs/how-to/configure-display-server.md | Extracted display server configuration into dedicated guide |
| docs/how-to/add-custom-docs.md | Extracted custom documentation setup into dedicated guide |
| docs/how-to/docker-*.md | Split docker.md into development and production guides |
| docs/how-to/*-holoviz-mcp.md | Renamed updates.md to update-holoviz-mcp.md for clarity |
| docs/explanation/display-system.md | New explanation document for display system architecture |
| docs/explanation/*.md | Updated cross-references to new file paths |
| docs/assets/logo.* | Replaced SVG logo with PNG version |
| Deleted files | Removed copilot.md, display-tool.md, display-server.md, examples.md, installation.md, ide-configuration.md, configuration.md (content moved/consolidated) |
Comments suppressed due to low confidence (3)
docs/tutorials/getting-started-copilot-vscode.md:9
- The company name should be "GitHub" (with capital H) not "Github".
docs/tutorials/getting-started-copilot-vscode.md:266 - The company name should be "GitHub" (with capital H) not "Github".
docs/tutorials/weather-dashboard-copilot-vscode.md:16 - The anchor link reference
#start-the-serverpoints to a subsection "### Start the Server" under "## Step 6: Verify Installation". This should work correctly as Markdown will generate the anchor from the heading text. However, it would be more precise to link to the parent section using#step-6-verify-installationsince "Start the Server" is a subsection of the verification process.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
No description provided.