Welcome to the Substack MCP Plus documentation! This directory contains all the guides and references you need to use and understand the project.
- Quick Start Guide - Get up and running in 5 minutes
- Authentication Guide - Set up your Substack credentials
- Current TODOs - Active work items you can contribute to
- Formatting Guide - Learn about all supported text formatting options
- Testing Documentation - Comprehensive testing guide including Claude Desktop
- Test Checklist - Quick testing reference
- Coverage Report - Detailed test coverage breakdown by module
- Troubleshooting Guide - Common issues and solutions
- Known Issues - Current limitations and workarounds
- Error Handling Fixes - Journey of fixing critical errors
- Features Overview - Detailed feature comparison and capabilities
- Vision & Roadmap - Future plans and project vision
- Confirmation System - Understanding the safety confirmation system
For contributors and developers working on the project:
- Implementation Guide - Claude Code implementation details
- Product Requirements - Original product requirements document
- Development Retrospective - Journey from JavaScript to Python
- MCP Semantic Completeness - Technical implementation details
- Claude Code's Perspective - The AI's view of development
- Error Handling Journey - Technical error fixing journey
- Main README
- Roadmap & Next Steps
- Contributing Guide
- Security Policy
- Claude Code Configuration
- Changelog
- License
docs/
├── README.md # Documentation index (this file)
├── QUICKSTART.md # Get started in 5 minutes
├── TODO.md # Current work items with subtasks
├── ROADMAP.md # Long-term vision and features
├── authentication.md # Authentication setup guide
├── formatting.md # Content formatting guide
├── TESTING.md # Comprehensive testing documentation
├── claude_desktop_test_checklist.md # Quick testing reference
├── COVERAGE_REPORT.md # Detailed test coverage by module
├── TROUBLESHOOTING.md # Common issues and solutions
├── KNOWN_ISSUES.md # Current limitations and workarounds
├── ERROR_HANDLING_FIXES.md # Consolidated error fix journey
├── FEATURES.md # Feature comparison and capabilities
├── VISION.md # Future plans and roadmap
├── CONFIRMATION_SYSTEM.md # Safety confirmation system
└── internal/ # Internal/development docs
├── GITHUB_READY.md # GitHub preparation summary
├── DOCS_CLEANUP_PLAN.md # Documentation cleanup plan
├── claude_md_improvements.md # CLAUDE.md enhancement summary
├── CLAUDE_CODE_PERSPECTIVE.md # AI's development perspective
├── ERROR_HANDLING_JOURNEY.md # Technical error fixing journey
├── claude-code-implementation-guide.md
├── substack-mcp-plus-prd.md
├── retrospective.md
├── mcp_semantic_completeness.md
└── substack-mcp-test-report.md
If you'd like to contribute to the documentation:
- Follow the existing documentation style
- Use clear, concise language
- Include examples where helpful
- Update this README when adding new docs
For more information about contributing to the project, see the main README.