Skip to content

Enhancement/claude refactor docs#118

Merged
MarcSkovMadsen merged 3 commits into
mainfrom
enhancement/claude-refactor-docs
Jan 24, 2026
Merged

Enhancement/claude refactor docs#118
MarcSkovMadsen merged 3 commits into
mainfrom
enhancement/claude-refactor-docs

Conversation

@MarcSkovMadsen

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings January 24, 2026 13:09

Copilot AI 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.

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-server points 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-installation since "Start the Server" is a subsection of the verification process.

Comment thread docs/how-to/configure-vscode.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MarcSkovMadsen MarcSkovMadsen merged commit 1c88610 into main Jan 24, 2026
5 of 11 checks passed
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