diff --git a/docs.json b/docs.json index a91b6adcd..cf5354b29 100644 --- a/docs.json +++ b/docs.json @@ -24,7 +24,8 @@ "index", "quickstart", "installation", - "editor" + "editor", + "faq" ] }, { diff --git a/faq.mdx b/faq.mdx new file mode 100644 index 000000000..b31f9d2d4 --- /dev/null +++ b/faq.mdx @@ -0,0 +1,247 @@ +--- +title: 'Frequently Asked Questions' +description: 'Find answers to the most common questions about Mintlify' +--- + +# Frequently Asked Questions + +Welcome to our FAQ page! Here you'll find answers to the most commonly asked questions about Mintlify. If you can't find what you're looking for, feel free to reach out to our support team. + +## Getting Started + + + + Mintlify is a modern documentation platform that helps teams create beautiful, interactive documentation websites. It uses MDX (Markdown + React components) to combine the simplicity of Markdown with the power of React components. You can write your content in Markdown files, configure your site with a simple JSON file, and deploy instantly to get a professional documentation site. + + + + Getting started is easy! Follow these steps: + 1. **Sign up** for a Mintlify account at mintlify.com + 2. **Connect your repository** (GitHub, GitLab, or Bitbucket) + 3. **Add a mint.json file** to configure your documentation site + 4. **Create your first .mdx files** with your content + 5. **Deploy automatically** - your site will be live in minutes! + + Check out our [Quickstart Guide](/quickstart) for detailed instructions. + + + + Not at all! While Mintlify is built for developers, you don't need extensive coding knowledge to create great documentation. If you can write Markdown (which is very simple), you can use Mintlify. Our platform handles all the complex technical aspects like hosting, performance optimization, and responsive design automatically. + + + + Yes! Mintlify supports importing from various sources: + - **Existing Markdown files** - Just add them to your repository + - **GitBook** - Use our migration tool to import your content + - **Notion** - Export your pages as Markdown and import them + - **Other platforms** - Most documentation can be converted to Markdown format + + Our team can also help with larger migrations - just contact support! + + + + You can have a basic documentation site running in under 10 minutes! Here's the typical timeline: + - **2-3 minutes**: Account setup and repository connection + - **5-10 minutes**: Basic configuration and first pages + - **30-60 minutes**: Customization and styling + - **Few hours to days**: Complete content migration (depending on size) + + + +## Features + + + + Mintlify comes packed with powerful features: + - **Interactive components** - Code blocks, tabs, callouts, and more + - **API documentation** - Auto-generated from OpenAPI specs + - **Search functionality** - Fast, intelligent search across all content + - **Analytics integration** - Track user engagement and popular content + - **Custom domains** - Use your own domain for branding + - **Team collaboration** - Multiple editors and review workflows + - **Version control** - Git-based workflow with branch previews + - **Mobile responsive** - Perfect on all devices + - **Dark/light mode** - User preference support + + + + Absolutely! Mintlify offers extensive customization options: + - **Brand colors** - Match your company's color scheme + - **Custom logo** - Add your logo to the navigation + - **Typography** - Choose from various font options + - **Layout options** - Sidebar navigation, topbar, and more + - **Custom CSS** - Advanced styling for specific needs + - **Favicon** - Custom favicon for your site + - **Footer customization** - Add links, social media, and more + + + + Yes! Mintlify has excellent API documentation support: + - **OpenAPI/Swagger integration** - Import your API specs automatically + - **Interactive API playground** - Users can test endpoints directly + - **Code examples** - Multiple programming languages supported + - **Authentication handling** - API key and OAuth examples + - **Response examples** - Show expected responses + - **SDK generation** - Auto-generate client libraries + + + + Mintlify integrates with many popular tools: + - **Version Control**: GitHub, GitLab, Bitbucket + - **Analytics**: Google Analytics, Mixpanel, Amplitude + - **Support**: Intercom, Zendesk, Crisp + - **Feedback**: Canny, UserVoice + - **Search**: Algolia integration for advanced search + - **Deployment**: Vercel, Netlify compatibility + - **CMS**: Headless CMS integrations available + + + + Yes! Mintlify includes a powerful search feature that: + - **Indexes all content** automatically + - **Provides instant results** as you type + - **Highlights matches** in context + - **Supports keyboard shortcuts** (⌘K or Ctrl+K) + - **Works offline** once the site is loaded + - **Can be customized** with Algolia for advanced features + + + +## Pricing + + + + Mintlify offers flexible pricing to fit teams of all sizes: + - **Starter Plan**: Free for public repositories and small teams + - **Pro Plan**: $120/month for advanced features and private repos + - **Enterprise Plan**: Custom pricing for large organizations + + All plans include hosting, SSL certificates, and core features. Visit our [pricing page](https://mintlify.com/pricing) for the most up-to-date information. + + + + Yes! Our Starter plan is completely free and includes: + - Unlimited public documentation sites + - All core features and components + - Community support + - Basic analytics + - Custom domain support + + This is perfect for open-source projects, personal documentation, or trying out the platform. + + + + The Pro plan includes everything in Starter plus: + - **Private repositories** support + - **Advanced analytics** and insights + - **Priority support** with faster response times + - **Team collaboration** features + - **Custom integrations** and webhooks + - **Advanced customization** options + - **White-label options** (remove Mintlify branding) + + + + Yes! We offer special pricing for: + - **Non-profit organizations** - 50% discount on all plans + - **Educational institutions** - Free Pro plan for qualifying schools + - **Open source projects** - Free Pro features for public repos + - **Startups** - Special startup pricing available + + Contact our sales team to learn more about these programs. + + + + Absolutely! You can: + - **Upgrade anytime** - Changes take effect immediately + - **Downgrade** - Changes take effect at the next billing cycle + - **Cancel anytime** - No long-term contracts required + - **Pause billing** - For temporary breaks (contact support) + + All plan changes are prorated, so you only pay for what you use. + + + +## Technical + + + + Mintlify primarily works with: + - **MDX files** (.mdx) - Markdown with React components + - **Markdown files** (.md) - Standard Markdown + - **JSON configuration** (mint.json) - Site configuration + - **OpenAPI specs** (.yaml, .json) - For API documentation + - **Images** - PNG, JPG, SVG, WebP + - **Videos** - MP4, WebM (embedded or linked) + + + + Deployment is automatic and seamless: + 1. **Push to your repository** - Any changes trigger a build + 2. **Automatic building** - Mintlify processes your files + 3. **Global CDN deployment** - Content distributed worldwide + 4. **Live in seconds** - Changes appear almost instantly + 5. **Branch previews** - Test changes before merging + + No manual deployment steps required! + + + + Mintlify is built for speed: + - **Static site generation** - Pre-built pages load instantly + - **Global CDN** - Content served from the nearest location + - **Image optimization** - Automatic compression and format selection + - **Code splitting** - Only load what's needed + - **Caching** - Intelligent caching strategies + - **Core Web Vitals** - Optimized for Google's performance metrics + + + + Security is a top priority: + - **HTTPS everywhere** - All sites use SSL certificates + - **Private repositories** - Keep sensitive docs private + - **Access controls** - Team-based permissions + - **SOC 2 compliance** - Enterprise-grade security + - **Regular security audits** - Continuous monitoring + - **Data encryption** - At rest and in transit + + + + Yes! Custom domains are supported on all plans: + - **Subdomain setup** - docs.yourcompany.com + - **Root domain** - yourcompany.com + - **SSL certificates** - Automatically provisioned + - **DNS configuration** - Simple CNAME setup + - **Multiple domains** - Point multiple domains to the same site + + + + We believe in data portability: + - **Export all content** - Download your MDX/Markdown files + - **Configuration backup** - Save your mint.json settings + - **Asset downloads** - Get all your images and files + - **No vendor lock-in** - Standard formats work anywhere + - **Migration assistance** - Our team can help with the process + + + + Yes! We offer various support options: + - **Community support** - Free help from our community + - **Email support** - Direct help from our team + - **Priority support** - Faster response times for Pro users + - **Custom development** - Paid consulting for special requirements + - **Migration services** - Professional help moving from other platforms + - **Training sessions** - Team onboarding and best practices + + + +## Still have questions? + +Can't find the answer you're looking for? We're here to help! + +- **Contact Support**: Reach out to our support team at [support@mintlify.com](mailto:support@mintlify.com) +- **Join our Community**: Connect with other users in our [Discord community](https://discord.gg/mintlify) +- **Schedule a Demo**: Book a personalized demo at [mintlify.com/demo](https://mintlify.com/demo) +- **Check our Status**: Monitor system status at [status.mintlify.com](https://status.mintlify.com) + +We typically respond to support requests within 24 hours (much faster for Pro users). \ No newline at end of file