GitHub
Copied to clipboard!

Documentation Index

Complete Guide to Vibe CMS with Claude Code

📚 Documentation Overview

Welcome to the Vibe CMS documentation! This index helps you find the right document for your needs.

For New Users

Start here if you're new to Vibe CMS:

  1. Quick Start Guide (5 min)

    • Fastest way to get up and running
    • Minimal explanation, maximum action
    • Perfect if you just want it working NOW

  2. Chapter 1: MCP Server Installation (15-20 min)

    • Complete installation walkthrough
    • Detailed explanations of each step
    • Troubleshooting for common issues
    • Recommended for thorough understanding

  3. User Manual (Reference)

    • Complete documentation structure
    • Overview of all topics
    • Navigation to all chapters
    • Future chapter roadmap

For Troubleshooting

Having issues? Check these:

  1. Troubleshooting Guide

    • Diagnostic decision trees
    • Step-by-step problem solving
    • Common issues and solutions
    • When to contact support

  2. FAQ

    • Quick answers to common questions
    • Organized by topic
    • Search-friendly format
    • Links to detailed guides

📖 Document Descriptions

Core Documentation

User Manual

Type: Comprehensive reference Audience: All users Status: Chapter 1 complete, more chapters coming

The master document for Vibe CMS. Contains:

  • Complete table of contents
  • Learning paths for different user types
  • Links to all chapters and appendices
  • Document conventions and structure

Use when: You want to understand the complete documentation structure

Chapter 1: MCP Server Installation

Type: Tutorial Audience: New users Time: 15-20 minutes Prerequisites: Claude Desktop app

Detailed guide to installing the Vibe CMS MCP server:

  • What MCP is and why you need it
  • Prerequisites checklist
  • Step-by-step installation (7 steps)
  • Verification procedures
  • Comprehensive troubleshooting (7 common issues)
  • Configuration deep dive
  • Best practices
  • Security guidelines

Use when: You're setting up Vibe CMS for the first time

Quick Reference

Quick Start Guide

Type: Quick reference Audience: Experienced developers Time: 5 minutes Prerequisites: Familiarity with JSON, command line

Streamlined installation guide:

  • 3-step installation process
  • Verification test
  • Common tasks examples
  • Quick troubleshooting
  • Links to detailed docs

Use when: You know what you're doing and just need the commands

Support Documentation

FAQ

Type: Question & Answer reference Audience: All users Sections: 9 categories, 50+ questions

Frequently asked questions organized by topic:

  1. General Questions (What is Vibe CMS, how it differs, pricing)
  2. Installation & Setup (Prerequisites, multiple projects, updates)
  3. Authentication & Security (Tokens, permissions, security best practices)
  4. Content Management (Collections, items, drafts, publishing)
  5. File Management (Upload types, folders, metadata, URLs)
  6. Translations & Locales (Multi-language, locale codes, defaults)
  7. Troubleshooting (Quick solutions to common problems)
  8. Performance & Limits (Rate limits, storage, optimization)
  9. Best Practices (Content, files, translations, API, security)

Use when: You have a specific question about how something works

Troubleshooting Guide

Type: Diagnostic reference Audience: Users experiencing issues Issues Covered: 6 major issue categories

Systematic problem-solving guide:

  • Diagnostic decision tree
  • Issue 1: MCP Server Not Found
  • Issue 2: Authentication Failed
  • Issue 3: Slow Performance
  • Issue 4: File Upload Problems
  • Issue 5: Translation Problems
  • Issue 6: Changes Not Appearing
  • Diagnostic commands
  • Log viewing and debugging
  • When to contact support

Use when: Something isn't working and you need to fix it

🙏 Which Document Do I Need?

By Goal

Goal: Get Vibe CMS working ASAP → Quick Start Guide

Goal: Understand everything thoroughly → Chapter 1: MCP Setup

Goal: Answer a specific question → FAQ

Goal: Fix a problem → Troubleshooting Guide

Goal: Learn about all available documentation → User Manual

By Experience Level

Complete Beginner

  1. Read User Manual introduction
  2. Follow Chapter 1: MCP Setup carefully
  3. Bookmark FAQ and Troubleshooting

Some Experience

  1. Use Quick Start Guide for installation
  2. Reference FAQ for specific questions
  3. Check Troubleshooting if issues arise

Expert User

  1. Quick Start Guide for new projects
  2. User Manual for advanced topics (when available)
  3. Direct API documentation (coming soon)

By Task

Installing Vibe CMS

Fixing Installation Issues

Understanding Features

  • FAQ → Content Management or File Management sections

Optimizing Performance

Working with Translations

Security Best Practices

📊 Documentation Statistics

Document Pages Words Reading Time Completeness
User Manual 5 1,500 7 min Framework done, chapters coming
Chapter 1: MCP Setup 20+ 7,000+ 20 min ✅ 100% complete
Quick Start Guide 2 500 3 min ✅ 100% complete
FAQ 15+ 5,000+ 15 min ✅ 100% complete
Troubleshooting 12+ 4,000+ 12 min ✅ 100% complete
Total 54+ 18,000+ ~1 hour Chapter 1 complete

🗺️ Documentation Roadmap

✅ Phase 1: Foundation (COMPLETE)

  • User Manual structure
  • Chapter 1: MCP Server Installation
  • Quick Start Guide
  • FAQ
  • Troubleshooting Guide
  • Documentation Index

📝 Phase 2: Core Concepts (Coming Soon)

  • Chapter 2: First Steps with Vibe CMS
  • Chapter 3: Project Setup
  • Chapter 4: Content Architecture
  • Chapter 5: File Management
  • Chapter 6: Fields and Data Types

🚀 Phase 3: Advanced Usage (Planned)

  • Chapter 7: Working with Claude Code
  • Chapter 8: Content Operations
  • Chapter 9: Multi-language Content

🔧 Phase 4: Integration (Planned)

  • Chapter 10: SDK Integration
  • Chapter 11: Security & Permissions
  • Chapter 12: Performance Optimization

📚 Phase 5: Reference (Planned)

  • Appendix A: MCP Tools Reference
  • Appendix B: Error Codes & Solutions
  • Appendix C: Migration Guides
  • Appendix D: API Endpoint Reference
  • Appendix E: Glossary

🤝 Contributing to Documentation

Found an error? Want to improve something?

How to Contribute

  1. Small fixes (typos, clarity):

    • Open an issue on GitHub
    • Or submit a pull request

  2. New content:

    • Discuss in community forum first
    • Follow documentation style guide
    • Submit PR with clear description

  3. Feedback:

    • Email: docs@vibecms.com
    • Discord: #documentation channel
    • Feedback forms linked in each doc

Documentation Standards

All documentation follows:

  • ✅ Clear, concise language
  • ✅ Step-by-step instructions
  • ✅ Real-world examples
  • ✅ Troubleshooting sections
  • ✅ Visual indicators (✅❌⚠️💡)
  • ✅ Code examples with syntax highlighting
  • ✅ Cross-references to related docs

📧 Getting Help

Quick Questions

→ FAQ

Technical Issues

→ Troubleshooting Guide

Installation Help

→ Chapter 1: MCP Setup → Troubleshooting section

Contact Support

🔄 Document Updates

Version: 1.0 Last Updated: November 2025

Change Log:

  • v1.0 (Nov 2025) - Initial release
    • User Manual framework
    • Complete Chapter 1: MCP Setup
    • Quick Start Guide
    • Comprehensive FAQ
    • Troubleshooting Guide
    • Documentation Index

Update Policy:

  • Critical fixes: Published immediately
  • Minor updates: Weekly batches
  • New chapters: As completed
  • Version bumps: Major content additions

Subscribe to Updates:

📱 Quick Links

Essential Documents

External Resources

Support Channels

🎓 Learning Paths

New User Path (2-3 hours)

  1. Read User Manual introduction (10 min)
  2. Complete Chapter 1: MCP Setup (20 min)
  3. Skim FAQ for overview (15 min)
  4. Practice with Claude Code (1-2 hours)
  5. Bookmark Troubleshooting for reference

Quick Setup Path (15 min)

  1. Quick Start Guide (5 min)
  2. Verify installation (5 min)
  3. Test with simple commands (5 min)

Deep Understanding Path (3-4 hours)

  1. Read User Manual completely
  2. Study Chapter 1 in detail
  3. Review all FAQ sections
  4. Understand Troubleshooting diagnostic trees
  5. Practice advanced scenarios

✨ What Makes This Documentation Special?

  1. AI-First Approach: Designed for Claude Code workflows
  2. Production-Grade: Professional documentation standards
  3. User-Tested: Based on real user feedback and pain points
  4. Comprehensive: From quick start to deep troubleshooting
  5. Practical: Real examples, not just theory
  6. Maintained: Regular updates and improvements
  7. Accessible: Multiple entry points for different needs
  8. Visual: Clear indicators, decision trees, and examples
  9. Searchable: Well-organized with clear navigation
  10. Community-Driven: Open to feedback and contributions

Ready to get started? → Choose your path above ☝️

Documentation Index v1.0 | Vibe CMS | Built for the AI era