Restructure documentation to prioritize Docker deployment#5
Merged
SPerekrestova merged 1 commit intomainfrom Nov 17, 2025
Merged
Conversation
## Major Changes **README.md:** - Moved Docker to primary "Quick Start" section at the top - Relocated Python setup to "Alternative Setup: Python (For Developers)" - Added clear "Why Docker?" section explaining benefits - Created comparison table: Docker vs Python deployment - Simplified user journey with step-by-step Docker setup - Emphasized Docker as recommended method for end users - Python method now clearly marked as alternative for developers **USAGE.md:** - Complete restructure with Docker-first approach - Updated Table of Contents to reflect new priority - "Quick Start with Docker" now the first section - Comprehensive "Why Docker?" explanation with 6 key benefits - Enhanced each tool section with "Via Claude Desktop" examples - Added practical Integration Examples using Claude Desktop - Moved Python setup to "Alternative Setup: Python (For Developers)" - Expanded Deployment Comparison table with detailed feature comparison - Added Claude Desktop troubleshooting section - Performance tips highlighting Docker advantages ## Documentation Philosophy **Docker (Recommended):** - Target audience: End users, production deployments - Zero Python knowledge required - One-command setup and updates - Cross-platform consistency - Complete isolation and security **Python (Alternative):** - Target audience: Developers, contributors - Required for code modifications - Easier debugging and customization - Direct access to source code ## Benefits for Users ✅ Clear guidance on which deployment method to choose ✅ Reduced complexity for non-technical users ✅ Better alignment with modern deployment practices ✅ Follows mcp-atlassian's successful Docker-first pattern ✅ Maintains full Python documentation for developers ✅ Improved onboarding experience with fewer steps ## Deployment Method Selection Users can now clearly see: - When to use Docker (most users) - When to use Python (developers only) - Detailed comparison of both approaches - Specific use cases for each method
SPerekrestova
deleted the
claude/docker-first-deployment-01N1JrXHQtQ58vqyayzTLTWC
branch
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
2 participants
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.
Major Changes
README.md:
USAGE.md:
Documentation Philosophy
Docker (Recommended):
Python (Alternative):
Benefits for Users
✅ Clear guidance on which deployment method to choose ✅ Reduced complexity for non-technical users
✅ Better alignment with modern deployment practices ✅ Follows mcp-atlassian's successful Docker-first pattern ✅ Maintains full Python documentation for developers ✅ Improved onboarding experience with fewer steps
Deployment Method Selection
Users can now clearly see: