Skip to main content

LeanMCP Documentation Cleanup Plan

File-by-File Analysis & Removal Plan

🗂️ Root Files

index.mdx - Keep (Already Updated)

  • Status: ✅ Already converted to LeanMCP content
  • Action: None needed

plan.mdx - Keep

  • Status: ✅ Our planning document
  • Action: None needed

README.md - Complete Rewrite

  • Current: Mintlify starter template instructions
  • Issues:
    • “Click on Use this template” - not relevant
    • Mintlify development setup instructions
    • GitHub app installation for Mintlify
  • Action: REWRITE - Make it about LeanMCP project setup

quickstart.mdx - Complete Rewrite

  • Current: Mintlify documentation setup guide
  • Issues:
    • “Start building awesome documentation” - wrong focus
    • Clone docs from GitHub instructions
    • Mintlify CLI installation
    • Dashboard references
  • Action: REWRITE - Make it “Quick Start with LeanMCP”

development.mdx - Complete Rewrite

  • Current: Mintlify development preview setup
  • Issues:
    • Node.js for Mintlify
    • Mintlify CLI commands
    • docs.json vs mint.json
  • Action: REWRITE - Make it “LeanMCP Development Guide”

docs.json - Major Navigation Overhaul

  • Current: Navigation has non-MCP sections
  • Issues:
    • “Essentials” section (markdown, code, images, etc.)
    • “API Documentation” with plant store examples
    • “Endpoint Examples” with CRUD operations
    • Two tabs: “Guides” and “Quickstart” - confusing
  • Action: RESTRUCTURE - New MCP-focused navigation

🗂️ api-reference/ Directory

ENTIRE DIRECTORY - Complete Overhaul

  • Current: Plant store API examples
  • Issues: All endpoints (create, delete, get, webhook) are plant store examples
  • Action: REPLACE with LeanMCP API endpoints

introduction.mdx

  • Current: Generic API documentation intro
  • Issues: References plant store, OpenAPI examples
  • Action: REWRITE - “LeanMCP API Introduction”

openapi.json

  • Current: Plant store OpenAPI spec
  • Action: REPLACE with LeanMCP API spec

endpoint/*.mdx (create, delete, get, webhook)

  • Current: Plant store CRUD operations
  • Action: REPLACE with LeanMCP endpoints:
    • Build MCP server
    • Deploy MCP server
    • Get MCP status
    • MCP webhooks

🗂️ essentials/ Directory

ENTIRE DIRECTORY - Remove or Repurpose

  • Current: Generic Mintlify documentation essentials
  • Issues: Not related to MCP/LeanMCP at all
  • Options:
    1. DELETE entirely
    2. REPURPOSE as “MCP Essentials”

markdown.mdx

  • Current: Generic markdown syntax guide
  • Action: DELETE or REPURPOSE as “Writing MCP Documentation”

code.mdx

  • Current: Generic code block examples
  • Action: DELETE or REPURPOSE as “MCP Code Examples”

images.mdx

  • Current: Generic image handling
  • Action: DELETE (not relevant to MCP)

navigation.mdx

  • Current: Mintlify navigation setup
  • Action: DELETE (not relevant to MCP)

reusable-snippets.mdx

  • Current: Generic snippets
  • Action: DELETE or REPURPOSE as “MCP Code Snippets”

settings.mdx

  • Current: Mintlify settings guide
  • Action: DELETE or REPURPOSE as “LeanMCP Configuration”

🗂️ snippets/ Directory

snippet-intro.mdx

  • Current: Generic snippet example
  • Action: REPLACE with MCP code snippets

🗂️ images/ Directory

hero-light.png & hero-dark.png

  • Current: Generic Mintlify hero images
  • Action: REPLACE with LeanMCP branding

checks-passed.png

  • Current: Generic checks image
  • Action: REPLACE with MCP build success image

🗂️ logo/ Directory

dark.svg & light.svg

  • Current: Generic Mintlify starter logos
  • Action: REPLACE with LeanMCP logos

🎯 Proposed New Structure

New Navigation (docs.json)

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": [
          "index",
          "quickstart", 
          "development"
        ]
      },
      {
        "group": "Building MCPs",
        "pages": [
          "building/introduction",
          "building/best-practices",
          "building/testing"
        ]
      },
      {
        "group": "API Reference", 
        "pages": [
          "api-reference/introduction",
          "api-reference/build",
          "api-reference/deploy",
          "api-reference/status"
        ]
      }
    ]
  }
}

New Page Structure

  1. Getting Started
    • index.mdx ✅ (done)
    • quickstart.mdx → LeanMCP quick start
    • development.mdx → LeanMCP development
  2. Building MCPs (new directory)
    • introduction.mdx → What are MCPs
    • best-practices.mdx → Art of good MCP design
    • testing.mdx → Testing AI workflows
  3. API Reference (rewritten)
    • introduction.mdx → LeanMCP API intro
    • build.mdx → Build MCP endpoint
    • deploy.mdx → Deploy MCP endpoint
    • status.mdx → Status check endpoint

📊 Summary

Files to DELETE

  • All of essentials/ (6 files)
  • Current api-reference/ endpoints (4 files)
  • Current images (3 files)
  • Current logos (2 files)

Files to REWRITE

  • README.md
  • quickstart.mdx
  • development.mdx
  • docs.json
  • api-reference/introduction.mdx
  • api-reference/openapi.json

Files to CREATE

  • building/ directory with MCP-focused content
  • New API endpoints for LeanMCP
  • New images/logos for LeanMCP branding

Total Impact

  • Remove: ~15 files of non-MCP content
  • Rewrite: ~6 files to be MCP-focused
  • Create: ~10 new MCP-focused files
  • Result: Clean, focused LeanMCP documentation