diff --git a/docs.json b/docs.json index c2e333f1..290f565f 100644 --- a/docs.json +++ b/docs.json @@ -45,6 +45,7 @@ "ai/contextual-menu", "ai/markdown-export", "mcp", + "guides/geo", "guides/claude-code", "guides/cursor", "guides/windsurf" diff --git a/guides/geo.mdx b/guides/geo.mdx new file mode 100644 index 00000000..d4294ad1 --- /dev/null +++ b/guides/geo.mdx @@ -0,0 +1,99 @@ +--- +title: "GEO guide: Optimize docs for AI search and answer engines" +sidebarTitle: "GEO" +description: "Make your documentation more discoverable and cited more frequently by AI tools" +icon: "cpu" +--- + +Optimize your documentation for both traditional search engines and AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews. + +Generative Engine Optimization (GEO) focuses on being cited by AI systems through comprehensive content and structured information, while traditional SEO targets search result rankings. + +## GEO quickstart + +### Initial setup + +1. **Make sure your docs are being indexed** in your `docs.json` settings +2. **Audit current pages** for missing descriptions and titles + +### Content improvements + +1. **Add comparison tables** to appropriate pages +2. **Audit headings** to ensure they answer common questions +3. **Improve internal linking** between related topics +4. **Test with AI tools** to verify accuracy + +## GEO best practices + +In general, well written and well structured documentation will have strong GEO. You should still prioritize writing for your users, and if your content is meeting their needs, you will be well on your way to optimizing for AI tools. Creating genuinely helpful content rather than optimizing for optimization's sake is rewarded by both traditional and AI search engines. + +Focus on: + +- Content aligned to user needs rather than keyword matching +- Structured, scannable information +- Direct answers to questions + +### Format for clarity + +These formatting practices help AI tools parse and understand your content: + +- Don't skip heading levels (H1 → H2 → H3) +- Use specific object names instead of "it" or "this" +- Label code blocks with their programming language +- Give images descriptive alt text +- Link to related concepts to help AI understand relationships + +### Answer questions directly + +Write content that addresses specific user questions: + +- Begin sections with the main takeaway +- Use descriptive headings that match common queries +- Break complex topics into numbered steps + +## Mintlify configuration + +Use these features to improve GEO. + +### Add descriptive page metadata + +Include clear titles and descriptions in your frontmatter: + +```mdx +--- +title: "API authentication guide" +description: "Complete guide to implementing API authentication with code examples" +--- +``` + +### Configure global indexing settings + +Add to your `docs.json`: + +```json +{ + "seo": { + "indexing": "all", + "metatags": { + "og:type": "website", + "og:site_name": "Your docs" + } + } +} +``` + +### LLMs.txt + +LLMs.txt files help AI systems understand your documentation structure, similar to how sitemaps help search engines. Mintlify automatically generates LLMs.txt files for your docs. No configuration is required. + +## Testing your documentation + +Test various AI tools with questions about your product and documentation to see how well your docs are being cited. + +**Ask AI assistants specific questions about your docs:** +- "How do I set up authentication using this API?" +- "Walk me through the installation process step by step" + +**Check that tools provide:** +- Correct code samples +- Accurate step-by-step instructions