diff --git a/docs.json b/docs.json index 39c3629f1..2c6970062 100644 --- a/docs.json +++ b/docs.json @@ -27,10 +27,22 @@ "pages": [ "index", "quickstart", + "features/capabilities", + "features/comparison", "ai-native", "migration" ] }, + { + "group": "Resources", + "icon": "book-open", + "pages": [ + "resources/learning-hub", + "resources/whats-new", + "changelog", + "resources/support" + ] + }, { "group": "Organize", "icon": "map", diff --git a/features/capabilities.mdx b/features/capabilities.mdx new file mode 100644 index 000000000..9d331d37b --- /dev/null +++ b/features/capabilities.mdx @@ -0,0 +1,189 @@ +--- +title: "Platform capabilities" +description: "Explore the powerful features that make Mintlify the best documentation platform" +--- + +## Core capabilities + + + + ### Write with ease + + Create beautiful documentation using MDX, our web editor, or your favorite code editor. Support for Markdown, React components, and rich media. + + **Key features:** + - Web-based editor with live preview + - Local CLI development + - 20+ interactive components + - Syntax highlighting for 100+ languages + - Image optimization and embeds + + + + ### Auto-generated API docs + + Transform OpenAPI and AsyncAPI specifications into beautiful, interactive API documentation automatically. + + **Key features:** + - OpenAPI 3.0+ support + - AsyncAPI support + - Interactive API playground + - SDK code examples + - Request/response examples + + + + ### Intelligent assistance + + Help users find answers instantly with AI-powered search and contextual assistance built into your documentation. + + **Key features:** + - Semantic search + - AI assistant chat + - Contextual suggestions + - Multi-language support + - Custom training on your docs + + + + ### Brand your docs + + Make your documentation uniquely yours with extensive customization options and theming capabilities. + + **Key features:** + - Custom themes and colors + - Custom fonts and typography + - Custom domain support + - Custom scripts and analytics + - React component integration + + + + ### Deploy anywhere + + Deploy your documentation with confidence using our global CDN or your preferred hosting provider. + + **Key features:** + - GitHub/GitLab integration + - Preview deployments + - CI/CD support + - Global CDN + - Custom hosting options + + + + ### Understand your users + + Track how users interact with your documentation and identify areas for improvement. + + **Key features:** + - Page view analytics + - Search analytics + - User feedback collection + - Integration with analytics tools + - Custom event tracking + + + +## Advanced features + +### Authentication & access control + +Protect your documentation with flexible authentication options: + +- **SSO integration** - SAML, OAuth, and custom providers +- **Role-based access** - Control who can view and edit content +- **Team management** - Invite and manage team members +- **Audit logs** - Track all changes and access + +### Collaboration + +Work together seamlessly: + +- **Real-time collaboration** - Edit with your team simultaneously +- **Comments and feedback** - Discuss changes inline +- **Version control** - Git-based workflow with full history +- **Preview deployments** - Review changes before publishing + +### Integrations + +Connect with your favorite tools: + + + + Google Analytics, Mixpanel, Amplitude, and more + + + Intercom, Front, and other support tools + + + Speakeasy and Stainless SDK generation + + + +## AI capabilities + +### AI assistant + +Embed an intelligent assistant directly in your documentation: + +- Answer questions based on your content +- Provide contextual help +- Support multiple languages +- Customize responses and behavior + +[Learn more about AI assistant →](/ai/assistant) + +### Agent workflows + +Automate documentation tasks with AI agents: + +- Auto-generate documentation from code +- Keep docs in sync with codebase +- Suggest improvements +- Answer questions in Slack/Discord + +[Explore agent workflows →](/agent/index) + +### Model Context Protocol + +Integrate with AI development tools: + +- Claude Code integration +- Cursor IDE support +- Windsurf compatibility +- Custom MCP servers + +[Read about MCP →](/ai/model-context-protocol) + +## Performance & reliability + +### Global infrastructure + +- **CDN delivery** - Fast loading worldwide +- **99.9% uptime** - Enterprise SLA available +- **Automatic scaling** - Handle traffic spikes +- **SSL certificates** - Automatic HTTPS + +### SEO optimization + +Built-in SEO features to help users find your docs: + +- Automatic sitemap generation +- Meta tag optimization +- Structured data markup +- Fast page loads +- Mobile-responsive design + +[SEO best practices →](/guides/seo) + +## Getting started + + + + Start building your documentation in minutes + + + Compare plans and features + + diff --git a/features/comparison.mdx b/features/comparison.mdx new file mode 100644 index 000000000..5df64c347 --- /dev/null +++ b/features/comparison.mdx @@ -0,0 +1,73 @@ +--- +title: "Feature comparison" +description: "Compare Mintlify plans and features to find the right fit for your team" +--- + +## Plans overview + +Choose the plan that best fits your documentation needs. + +| Feature | Starter | Growth | Enterprise | +|---------|---------|--------|------------| +| **Pages** | Up to 100 | Unlimited | Unlimited | +| **Team members** | 3 | 10 | Unlimited | +| **Custom domain** | | | | +| **AI assistant** | | | | +| **Analytics** | Basic | Advanced | Advanced | +| **API playground** | | | | +| **Authentication** | | | | +| **SSO** | | | | +| **Priority support** | | | | +| **SLA** | | | | + +## Core capabilities + +### Content creation + +Build beautiful documentation with our comprehensive toolset: + +- **Web editor** - Browser-based editing with live preview +- **CLI development** - Local development with hot reload +- **MDX support** - Write in Markdown with React components +- **Component library** - 20+ pre-built interactive components +- **Code blocks** - Syntax highlighting for 100+ languages +- **API documentation** - Auto-generate from OpenAPI/AsyncAPI specs + +### AI-powered features + +Enhance your documentation with AI capabilities: + +- **AI assistant** - Contextual answers from your docs +- **Smart search** - Semantic search across all content +- **Auto-suggestions** - AI-powered content recommendations +- **Agent workflows** - Automate documentation tasks + +### Deployment & hosting + +Deploy with confidence: + +- **Global CDN** - Fast loading worldwide +- **Preview deployments** - Test changes before going live +- **GitHub/GitLab integration** - Deploy from your repository +- **Custom domains** - Use your own domain +- **SSL certificates** - Automatic HTTPS + +### Analytics & insights + +Understand your users: + +- **Page views** - Track documentation usage +- **Search analytics** - See what users are looking for +- **User feedback** - Collect ratings and comments +- **Integration support** - Connect to Google Analytics, Mixpanel, and more + +## Getting started + + + + Deploy your first docs site in minutes + + + Compare plans and pricing details + + diff --git a/index.mdx b/index.mdx index 8f88a0448..94a6c9945 100644 --- a/index.mdx +++ b/index.mdx @@ -47,6 +47,15 @@ export const HeroCard = ({ filename, title, description, href }) => { Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams. + +
@@ -71,5 +80,31 @@ export const HeroCard = ({ filename, title, description, href }) => { href="/components/accordions" />
+ + diff --git a/resources/learning-hub.mdx b/resources/learning-hub.mdx new file mode 100644 index 000000000..e8e1febbd --- /dev/null +++ b/resources/learning-hub.mdx @@ -0,0 +1,177 @@ +--- +title: "Learning hub" +description: "Tutorials, guides, and resources to help you master Mintlify" +--- + +## Getting started + +New to Mintlify? Start here to get up and running quickly. + + + + Deploy your first documentation site in under 5 minutes + + + Set up local development environment + + + Learn to use the browser-based editor + + + Structure your documentation site + + + +## Tutorials + +Step-by-step guides for common tasks. + +### Content creation + + + + Learn the basics of creating documentation pages with MDX. + + - [Text formatting](/create/text) + - [Code blocks](/create/code) + - [Images and media](/create/image-embeds) + - [Reusable snippets](/create/reusable-snippets) + + + + Build interactive documentation with pre-built components. + + - [Cards and tiles](/components/cards) + - [Tabs and accordions](/components/tabs) + - [Code groups](/components/code-groups) + - [Callouts and banners](/components/callouts) + + + + Auto-generate beautiful API docs from your specifications. + + - [OpenAPI setup](/api-playground/openapi-setup) + - [Adding SDK examples](/api-playground/adding-sdk-examples) + - [MDX customization](/api-playground/mdx-setup) + + + +### Customization + + + + Make your documentation match your brand identity. + + - [Custom themes](/customize/themes) + - [Custom fonts](/customize/fonts) + - [Custom domain](/customize/custom-domain) + - [Custom 404 page](/customize/custom-404-page) + + + + Unlock powerful capabilities for your documentation. + + - [Authentication](/deploy/authentication-setup) + - [Custom scripts](/customize/custom-scripts) + - [React components](/customize/react-components) + + + +### Deployment + + + + Get your documentation live and accessible. + + - [GitHub integration](/deploy/github) + - [GitLab integration](/deploy/gitlab) + - [Preview deployments](/deploy/preview-deployments) + - [CI/CD setup](/deploy/ci) + + + + Choose the right hosting setup for your needs. + + - [Cloudflare setup](/deploy/cloudflare) + - [Vercel integration](/deploy/vercel) + - [Route53 + CloudFront](/deploy/route53-cloudfront) + - [Reverse proxy](/deploy/reverse-proxy) + + + +## Best practices + +Learn from experts to create exceptional documentation. + + + + Choose the right content types for your audience + + + Make your docs discoverable + + + Build inclusive documentation + + + Write clear, consistent content + + + Structure for easy discovery + + + Keep docs fresh and accurate + + + +## AI-powered workflows + +Enhance your documentation with AI capabilities. + + + + Add intelligent search and answers to your docs + + + Automate documentation tasks with AI agents + + + Get documentation help in Slack + + + Answer questions in Discord + + + +## Use cases + +See how teams use Mintlify for different documentation needs. + + + + Technical documentation for APIs and SDKs + + + Internal or customer-facing knowledge bases + + + Self-service support documentation + + + +## Additional resources + + + + Complete API documentation + + + Latest features and updates + + + Join our community + + + Get help from our team + + diff --git a/resources/support.mdx b/resources/support.mdx new file mode 100644 index 000000000..2bc7471df --- /dev/null +++ b/resources/support.mdx @@ -0,0 +1,138 @@ +--- +title: "Support & resources" +description: "Get help, connect with the community, and access additional resources" +--- + +## Get help + + + + Get in touch with our support team for technical assistance + + + Suggest new features and vote on community ideas + + + Found an issue? Let us know on GitHub + + + Check system status and uptime + + + +## Community + +Join our community to connect with other Mintlify users, share tips, and get help. + + + + Ask questions and share knowledge with the community + + + Chat with other users and the Mintlify team + + + Follow us for updates and announcements + + + Connect with us professionally + + + +## Documentation resources + + + + Tutorials and guides to master Mintlify + + + Complete API documentation + + + Best practices and use cases + + + Latest features and updates + + + Full release history + + + Migrate from other platforms + + + +## Company resources + + + + Product updates, tutorials, and insights + + + See how teams use Mintlify + + + Compare plans and pricing + + + Join our team + + + +## Enterprise + +Need enterprise-grade features and support? + + + Learn about our enterprise offerings including: + - Dedicated support and SLA + - SSO and advanced security + - Custom contracts and pricing + - Priority feature requests + - Training and onboarding + + +## Legal & security + + + + How we handle your data + + + Our terms and conditions + + + Security practices and compliance + + + +## Quick links + +### For developers + +- [CLI installation](/installation) +- [GitHub integration](/deploy/github) +- [API playground](/api-playground/overview) +- [Custom components](/customize/react-components) + +### For content creators + +- [Web editor](/editor/index) +- [Writing content](/create/text) +- [Components library](/components/index) +- [SEO optimization](/guides/seo) + +### For teams + +- [Dashboard permissions](/dashboard/permissions) +- [SSO setup](/dashboard/sso) +- [Team collaboration](/editor/collaborate) +- [Analytics](/insights/overview) + +## Still need help? + +Can't find what you're looking for? Our support team is here to help. + + + Reach out to our team for personalized assistance + diff --git a/resources/whats-new.mdx b/resources/whats-new.mdx new file mode 100644 index 000000000..68495182b --- /dev/null +++ b/resources/whats-new.mdx @@ -0,0 +1,118 @@ +--- +title: "What's new" +description: "Latest features and updates from Mintlify" +--- + +## Recent highlights + +Stay up to date with the latest features, improvements, and updates to the Mintlify platform. + + + + Documentation sites now auto-generate installation guides for AI agents + + + See real-time changes as you edit without creating preview deployments + + + Import any file as a snippet from anywhere in your docs + + + AI analyzes conversations to identify documentation gaps + + + +## Latest releases + +### January 2026 + + + + Documentation sites now automatically generate an `install.md` file that aggregates installation-related pages for AI agents. Custom files take priority over auto-generated versions. + + + + - **Live preview**: Real-time changes without preview deployments + - **Unused files section**: Drag-and-drop support for unused pages + - **Branch search**: Easier navigation between deployment branches + + + + Select tiers of assistant message allotments per month from the dashboard. + + + + Tabs and code groups now synchronize selection across pages for consistent language or framework choices. + + + +### December 2025 + + + + The agent monitors Git repositories and suggests documentation updates when user-facing code changes are detected. + + + + Add bots powered by the assistant to Slack workspaces and Discord servers for real-time answers. + + + + Interactive widget displays all changed files in preview deployments with one-click navigation. + + + + Display automatic timestamps on pages to show when content was last updated. + + + +## Feature categories + + + + Assistant improvements, agent automation, and AI-powered workflows + + + Web editor enhancements, live preview, and collaboration tools + + + OpenAPI improvements, playground enhancements, and SDK support + + + Speed optimizations, caching improvements, and infrastructure upgrades + + + New analytics tools, support platforms, and third-party connections + + + Themes, fonts, styling options, and branding capabilities + + + +## Stay informed + + + + View complete release history with detailed updates + + + Subscribe to updates via RSS + + + Join discussions and share feedback + + + Suggest new features and improvements + + + +## Coming soon + +We're constantly working on new features and improvements. Here's what's on the horizon: + +- Enhanced collaboration features +- Advanced analytics and insights +- More customization options +- Additional integrations + +Want to influence our roadmap? [Share your feedback](https://github.com/orgs/mintlify/discussions/categories/feature-requests) or [contact our team](https://mintlify.com/contact/sales).