|
| 1 | +# Documentation Migration Plan |
| 2 | + |
| 3 | +## Overview |
| 4 | +This document outlines the plan for merging the MCP documentation from two repositories: |
| 5 | +- Current repo (`modelcontextprotocol/specification`): Hugo/Hextra format |
| 6 | +- Imported repo (`modelcontextprotocol/docs`): Mintlify/MDX format |
| 7 | + |
| 8 | +The goal is to create a unified documentation system under Mintlify while preserving the full commit history from both repositories. |
| 9 | + |
| 10 | +## Repository Structure |
| 11 | +- Keep `specification/` as the main repository |
| 12 | +- Move `imported-docs/` content into a new `user-guide/` directory |
| 13 | +- Maintain separate schema validation and examples in the root |
| 14 | + |
| 15 | +## Content Migration Approach |
| 16 | +- Convert Hugo/Hextra shortcodes (like `{{< callout >}}`) to Mintlify MDX components |
| 17 | +- Preserve all Mermaid diagrams (natively supported in both) |
| 18 | +- Update internal links across all documents |
| 19 | +- Keep versioned specification documentation intact |
| 20 | + |
| 21 | +## Mintlify Configuration |
| 22 | +- Keep `docs.json` as the configuration file (Mintlify's latest format) |
| 23 | +- Update navigation structure to include specification pages |
| 24 | +- Add specification versions as separate navigation groups |
| 25 | + |
| 26 | +## Structure Reorganization |
| 27 | +- `/docs/` → User guide documentation (from imported repo) |
| 28 | +- `/specification/` → Specification docs (from current repo) |
| 29 | +- `/resources/` → Resources (from current repo) |
| 30 | +- `/schema/` → Schema definitions (keep as-is) |
| 31 | + |
| 32 | +## Link and Reference Handling |
| 33 | +- Update all `{{< ref >}}` links to Mintlify format |
| 34 | +- Preserve external links to GitHub repos |
| 35 | +- Update the specification links in the user guide to internal links |
| 36 | + |
| 37 | +## Content Conversion Tasks |
| 38 | +- Identify and convert all Hugo shortcodes |
| 39 | +- Replace front matter metadata for Mintlify compatibility |
| 40 | +- Convert weight-based ordering to explicit ordering in docs.json |
| 41 | + |
| 42 | +## Implementation Steps |
| 43 | +1. Import docs repository as Git subtree (preserving history) ✓ |
| 44 | +2. Create new directory structure |
| 45 | +3. Convert and migrate content |
| 46 | +4. Update configuration files |
| 47 | +5. Test build locally with Mintlify |
| 48 | +6. Review and validate content |
| 49 | +7. Deploy to production |
0 commit comments