Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Oct 3, 2025

Optimized documentation for AI search engines and answer engines following Mintlify GEO best practices. Added SEO configuration, improved headings to answer common questions, added language tags to code blocks, enhanced metadata, and improved internal linking throughout the documentation.


Created by Mintlify agent

Greptile Overview

Greptile Summary

This PR implements comprehensive GEO (Generative Engine Optimization) improvements across the HelixDB documentation following Mintlify best practices.

Key changes:

  • Moved indexing configuration from metatags to correct top-level SEO object in docs.json
  • Converted all section headings to question format (e.g., "How do I install the Helix CLI?") to better match natural language queries from AI search engines
  • Enhanced metadata descriptions throughout with more specific, keyword-rich content
  • Added "Next steps" and "Related operations" sections with internal linking to improve documentation discoverability
  • Improved opening paragraphs to be more concise and feature-focused

Impact:
These changes optimize the documentation for AI-powered search engines and answer engines, making it easier for users to find relevant information through natural language queries. All changes maintain technical accuracy while improving content structure and navigation.

Important Files Changed

File Analysis

Filename Score Overview
docs.json 5/5 Moved indexing property to correct location in SEO configuration (from metatags to top-level seo object)
documentation/cli-v2/getting-started.mdx 5/5 Enhanced titles and step headings with question format for better GEO, improved description to be more specific and actionable
documentation/getting-started/graph-database.mdx 5/5 Converted headings to question format, added Next steps section with internal links to improve discoverability
documentation/hql/hql.mdx 5/5 Added description metadata, reformatted headings as questions, improved opening paragraph to be more concise and feature-focused
documentation/sdks/helix-py.mdx 5/5 Enhanced description to be comprehensive, converted all section headings to question format, improved opening paragraph clarity

Sequence Diagram

sequenceDiagram
    participant User
    participant AI Search Engine
    participant Docs
    participant Mintlify
    
    User->>AI Search Engine: "How do I install HelixDB CLI?"
    AI Search Engine->>Docs: Query documentation
    Docs->>Docs: Match question-format headings
    Docs->>Docs: Check SEO metadata
    Docs-->>AI Search Engine: Return optimized content
    AI Search Engine->>AI Search Engine: Parse structured answers
    AI Search Engine-->>User: Direct answer with link
    
    User->>Docs: Click to documentation
    Docs->>Mintlify: Render page with metadata
    Mintlify->>Mintlify: Apply SEO config (indexing: all)
    Docs->>User: Show "Next steps" links
    User->>Docs: Navigate related content

Loading

mintlify bot added 30 commits October 3, 2025 10:05
Copy link
Collaborator

@Gand4lf Gand4lf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Gand4lf Gand4lf marked this pull request as ready for review November 27, 2025 00:28
@Gand4lf Gand4lf merged commit 8c53c5b into main Nov 27, 2025
3 checks passed
@Gand4lf Gand4lf deleted the mintlify/geo-optimization-review-89215 branch November 27, 2025 00:28
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants