How matanfield/docs works
Main Components
a) Documentation Structure Layer
• Content Repository (MDX files)
• API Reference System
• Asset Management (images, snippets)
• Configuration System (mint.json)
b) Development Infrastructure
• Local Development Server
• CLI Tool Interface
• Build System
c) Deployment Layer
• GitHub Integration
• Auto-deployment System
• Production Environment
┌─────────────────────────────────────────────────────────┐
• Content Layer │
• ┬─────────────────┬─────────────────┬────┤
• MDX Content │ API Reference │ Assets │ │
• Essentials │ - Endpoints │ - Images │ │
• Guides │ - OpenAPI Spec │ - Snippets │ │
• ┬───────┴────────┬────────┴────────┬────────┘ │
┌───────▼───────────────▼─────────────────▼──────────┐ │
• Configuration Layer │ │
• (mint.json) │ │
• ┬──────────────────────────┬─┘ │
┌───────────────────────▼──────────────┐ ┌────────▼──────▼─┐
• Development Environment │ │ Production │
• Mintlify CLI │ │ Environment │
• Local Preview Server │ │ - GitHub App │
• ┘ │ - Auto Deploy │
• ┘
Key Relationships to Highlight
• How the mint.json configuration file orchestrates all components
• Content pipeline from local development to production
• Demonstrate the relationship between API reference and documentation
• How assets are integrated into the content structure
Important Details
• File type indicators (.mdx, .json)
• Component version information
• Integration points with external services (GitHub)
• Build and deployment flow directions