Skip to main content

Tutorials

Step-by-step tutorials to get you started with DocuMCP and master advanced features.

Learning Path​

Follow this sequence for the best onboarding experience:

For New Users​

  1. Environment Setup — Verify prerequisites, install DocuMCP, and connect it to your AI client
  2. Getting Started with DocuMCP — Run your first repository analysis and documentation deployment
  3. User Onboarding — Common MCP usage patterns and best practices
  4. First Documentation Deployment — End-to-end walkthrough with a real project

For Advanced Users​

  1. Memory Workflows — Use the knowledge graph to improve recommendations over time
  2. Development Setup — Contribute to DocuMCP (contributor guide)

Tutorials at a Glance​

TutorialTimeWho it's for
Environment Setup5 minEveryone — start here
Getting Started15 minNew users
User Onboarding10 minNew users wanting usage patterns
First Deployment20 minUsers ready for end-to-end walkthrough
Memory Workflows15 minUsers wanting smarter recommendations
Development Setup20 minContributors to DocuMCP

Quick Start Prompts​

Once DocuMCP is connected to your AI client, try these prompts:

Analyze my repository at /path/to/my-project
Recommend a static site generator based on my repository analysis
Set up a Diataxis documentation structure for Docusaurus in my docs folder
Deploy my documentation to GitHub Pages

What You Will Learn​

  • Repository Analysis — how DocuMCP understands your project's structure and tech stack
  • SSG Recommendations — choosing the right static site generator with confidence scores
  • Documentation Generation — creating Diataxis-compliant documentation structures automatically
  • Deployment Automation — GitHub Actions workflows for GitHub Pages and Vercel
  • Memory System — how DocuMCP learns from past analyses to improve future recommendations

Prerequisites​

RequirementDetails
Node.jsv20.0.0 or higher
npmLatest stable
GitLatest stable
AI clientClaude Desktop, Cursor, or VS Code with GitHub Copilot

See Environment Setup for installation and verification steps.

Getting Help​