Merge pull request #33 from HelixDB/mintlify/geo-optimization-review-89215

Gand4lf · web-flow · commit 8c53c5b90571 · 2025-11-26T16:28:14.000-08:00
GEO Optimization Complete
diff --git a/docs.json b/docs.json
@@ -327,6 +327,7 @@
     }
   },
   "seo": {
+    "indexing": "all",
     "metatags": {
       "description": "HelixDB Documentation to get you started with HelixDB",
       "keywords": "HelixDB, Documentation, Getting Started, CLI, SDK, Guides, Features, Blogs, RAG, Database, Database, Graph Database, Vector Database, AI, Agents, LLMs, Knowledge Graphs, Retrieval Augmented Generation, Knowledge Graphs, AI Agents, Document databases",
@@ -336,7 +337,6 @@
       "og:description": "HelixDB Documentation",
       "og:type": "website",
       "og:site_name": "HelixDB Documentation",
-      "indexing": "all",
       "category": "Technology",
       "language": "en",
       "author": "HelixDB"
diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx
@@ -1,6 +1,6 @@
 ---
-title: "Getting Started"
-description: "Install, configure, and set up the Helix CLI v2 for your development workflow"
+title: "Getting started with HelixDB CLI v2"
+description: "Step-by-step guide to install, configure, and deploy your first HelixDB instance with CLI v2"
 icon: "rocket"
 ---
 
@@ -13,7 +13,7 @@ icon: "rocket"
 
 <Steps>
 
-<Step title="Quick Install">
+<Step title="How do I install the Helix CLI?">
   Use the official installer script to automatically download and set up the Helix CLI:
 
 ```bash
@@ -27,13 +27,13 @@ curl -sSL https://install.helix-db.com | bash
   </Note>
 </Step>
 
-<Step title="Create project">
+<Step title="How do I create a new HelixDB project?">
 ```bash 
 helix init
 ```
 </Step>
 
-<Step title="Create schema and queries">
+<Step title="How do I define schemas and queries?">
   Inside the schema.hx file, create your schema.
   ```js
   N::User {
@@ -57,13 +57,13 @@ QUERY getUser(name: String) =>
 
 </Step>
 
-<Step title="Build and deploy">
+<Step title="How do I deploy my HelixDB instance?">
 ```bash 
 helix push dev 
 ```
 </Step>
 
-<Step title="Test connection">
+<Step title="How do I test my HelixDB connection?">
   **Create a user**
   ```bash
   curl -X POST http://localhost:6969/createUser -H 'Content-Type: application/json' -d '{"name": "John Doe", "email": "john.doe@example.com"}'
diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx
@@ -6,9 +6,9 @@ icon: 'chart-network'
 
 A graph database is a type of database that stores data using a graph structure, where information is represented through **nodes** (data points) and **edges** (relationships between nodes). Unlike traditional databases that use tables or documents, graph databases excel at managing highly connected data and complex relationships.
 
-## How Graph Databases Work
+## How do graph databases work?
 
-Graph databases are built on two fundamental concepts:
+Graph databases store data using two fundamental concepts:
 
 1. **Nodes** - These are the entities or objects in your data (like people, products, or locations)
 2. **Edges** (or relationships) - These are the connections between nodes that describe how they relate to each other
@@ -28,7 +28,7 @@ In this simple example:
 - Edges show relationships like friendships, employment, and product interactions
 - Both nodes and edges can have properties (additional data attributes)
 
-## Common Use Cases
+## What are graph databases used for?
 
 ### 1. Social Networks
 Perfect for modeling:
@@ -58,9 +58,9 @@ Great for:
 - AI and machine learning
 - Research and discovery
 
-## When to Use a Graph Database
+## When should I use a graph database?
 
-Consider using a graph database when:
+Use a graph database when:
 
 - Your data has many interconnected relationships
 - You need to perform complex queries involving multiple relationships
@@ -70,9 +70,26 @@ Consider using a graph database when:
 
 
 
-## Benefits Over Traditional Databases
+## What are the benefits of graph databases?
 
 1. **Performance**: Faster for relationship-heavy queries
 2. **Flexibility**: Easier to modify and extend the data model
 3. **Intuitive**: More natural way to model connected data
 4. **Scalability**: Better handling of complex relationship patterns
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="What is HelixDB?" icon="database" href="/documentation/getting-started/helixdb">
+    Learn about HelixDB's architecture and features
+  </Card>
+  <Card title="Getting started" icon="rocket" href="/documentation/cli-v2/getting-started">
+    Install and deploy your first graph database
+  </Card>
+  <Card title="Social network guide" icon="users" href="/guides/social-network">
+    Build a social network with graph databases
+  </Card>
+  <Card title="HelixQL basics" icon="book-open" href="/documentation/hql/hql">
+    Learn to query graph data
+  </Card>
+</CardGroup>
diff --git a/documentation/getting-started/helixdb.mdx b/documentation/getting-started/helixdb.mdx
@@ -8,16 +8,18 @@ icon: 'database'
   Rust version 1.88.0 or higher is required. Make sure you have an updated version of Rust installed. Run `rustup update` to update your Rust version.
 </Warning>
 
-## Key Features
+## What are HelixDB's key features?
+
+HelixDB provides:
 
 - **High Performance**: Purpose-built storage engine optimized for both graph and vector operations
 - **Type Safety**: Explicit type definitions to ensure data integrity
 - **Developer-Friendly**: Simple setup and migration
 - **Secure**: Options for encryption at rest
 
-## Data Model
+## How does HelixDB store data?
 
-HelixDB follows the property graph model, which consists of:
+HelixDB uses a property graph model with three core components:
 
 - **Nodes**: Represent entities with unique identifiers and properties
   ```js
@@ -46,3 +48,20 @@ HelixDB follows the property graph model, which consists of:
   ```
 
 This model allows for rich representation of complex domains while maintaining query performance.
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Getting started with CLI" icon="rocket" href="/documentation/cli-v2/getting-started">
+    Install and deploy your first HelixDB instance
+  </Card>
+  <Card title="Learn HelixQL" icon="book-open" href="/documentation/hql/hql">
+    Master the HelixQL query language
+  </Card>
+  <Card title="Schema definitions" icon="table" href="/documentation/hql/schema/schema-definition">
+    Define your graph structure
+  </Card>
+  <Card title="Python SDK" icon="python" href="/documentation/sdks/helix-py">
+    Use HelixDB with Python
+  </Card>
+</CardGroup>
diff --git a/documentation/hql/create/addN.mdx b/documentation/hql/create/addN.mdx
@@ -1,12 +1,12 @@
 ---
-title: "Nodes"
-description: "Learn how to create nodes in your graph."
+title: "Create nodes"
+description: "How to create nodes in your HelixDB graph with AddN including examples for empty nodes, parameterized nodes, and predefined properties"
 icon: "draw-circle"
 ---
 
-## Create Nodes using `AddN` &nbsp;
+## How do I create nodes in HelixDB?
 
-Create new nodes in your graph.
+Use `AddN` to create new nodes in your graph with optional properties.
 
 ```rust
 AddN<Type>
@@ -312,3 +312,10 @@ curl -X POST \
   -d '{}'
 ```
 </CodeGroup>
+
+## Related operations
+
+- [Select nodes](/documentation/hql/select/selectN) - Query existing nodes
+- [Create edges](/documentation/hql/create/addE) - Connect nodes with relationships
+- [Update nodes](/documentation/hql/updating) - Modify node properties
+- [Schema definitions](/documentation/hql/schema/schema-definition) - Define node types
diff --git a/documentation/hql/hql.mdx b/documentation/hql/hql.mdx
@@ -1,32 +1,34 @@
 ---
 title: "What is HelixQL?"
+description: "Learn about HelixQL, a strongly typed compiled query language for graph and vector operations in HelixDB"
 sidebarTitle: "What is HQL?"
 icon: "book-open"
 ---
 
-HelixQL is a strongly typed, compiled query language for HelixDB.
-It was inspired from a combination of Gremlin, Cypher and Rust.
+HelixQL is a strongly typed, compiled query language for HelixDB that combines the best features of Gremlin, Cypher, and Rust to provide type-safe graph and vector queries.
 
-## Why yet another query language?
+## Why use HelixQL instead of other query languages?
 
-Over the past few years, we've used Gremlin extensively for graph queries.
-It's powerful and very expressive, but it's also extremely verbose and horrible to read after any substantial complexity.
+HelixQL addresses key limitations found in existing graph query languages:
 
-The other major issue is that it's obviously completely dynamic and is parsed at runtime when the query is executed.
-This leads to a horrible developer experience, not knowing if the query is valid until runtime.
+- **Type safety**: Queries are validated at compile time, catching errors before runtime
+- **Readability**: Clean, concise syntax that remains readable even for complex queries
+- **Performance**: Compiled queries execute faster than dynamically parsed alternatives
+- **Developer experience**: IDE support with autocomplete and type checking
 
-Building a new query language from scratch is obviously a big undertaking,
-but we thought it was a necessary step to improve the developer experience and make building with graphs better.
+Unlike Gremlin's verbose syntax or Cypher's runtime parsing, HelixQL provides a modern, type-safe approach to graph querying.
 
-**Example Query Syntax:**
+## How do I write a HelixQL query?
+
+HelixQL queries follow a simple, declarative syntax:
 
 ```js
 QUERY QueryName(param1: Type, param2: Type) =>
     result <- traversal_expression
     RETURN result
 ```
 
-#### Components
+### Query components
 
 - `QUERY`: Keyword to start a query definition
 - `QueryName`: Identifier for the query
diff --git a/documentation/hql/schema/schema-definition.mdx b/documentation/hql/schema/schema-definition.mdx
@@ -1,16 +1,15 @@
 ---
-title: "Schema Definition"
-description: "Text, title, and styling in standard markdown"
+title: "Schema definition"
+description: "How to define schemas for nodes, edges, and vectors in HelixDB with type-safe property definitions"
 ---
 
-## Schema Definition
+## How do I define schemas in HelixDB?
 
-HelixQL uses a schema definition to define the structure of the graph.
-Note that every node, edge and vector has an implicit `ID` field. that is not in the schema definition.
+Define the structure of your graph using HelixQL schema definitions. Every node, edge, and vector automatically includes an implicit `ID` field.
 
-### Node Schema
+### Node schemas
 
-Defines node types and their properties in the graph.
+Define node types and their properties:
 
 ```rust
 N::NodeType {
@@ -21,9 +20,9 @@ N::NodeType {
 
 ---
 
-### Edge Schema
+### Edge schemas
 
-Defines relationships between nodes and their properties.
+Define relationships between nodes with properties:
 
 ```rust
 E::EdgeType {
@@ -38,9 +37,9 @@ E::EdgeType {
 
 ---
 
-### Vector Schema
+### Vector schemas
 
-Defines the vector type.
+Define vector types with metadata properties:
 
 ```rust
 V::VectorType {
diff --git a/documentation/hql/select/selectN.mdx b/documentation/hql/select/selectN.mdx
@@ -1,12 +1,12 @@
 ---
-title: "Nodes"
-description: "Learn how to select nodes in your graph."
+title: "Select nodes"
+description: "How to select and query nodes in your HelixDB graph by ID or type with code examples"
 icon: "draw-circle"
 ---
 
-## `N` &nbsp; Nodes
+## How do I select nodes in HelixDB?
 
-Select nodes from your graph to begin traversal.
+Use `N` to select nodes from your graph by ID or type to begin traversals.
 
 ```rust
 N<Type>(node_id)
@@ -245,3 +245,10 @@ curl -X POST \
 </CodeGroup>
 
 <Note>You can also do specific property-based filtering, e.g., returning only ID, see the [Property Filtering](../properties/property-access). You can also do aggregation steps, e.g., returning the count of nodes, see the [Aggregations](../aggregation).</Note>
+
+## Related operations
+
+- [Create nodes](/documentation/hql/create/addN) - Add new nodes to your graph
+- [Traversals](/documentation/hql/traversals/steps_nodes) - Navigate between connected nodes
+- [Conditionals](/documentation/hql/conditionals/conditions) - Filter nodes by properties
+- [Property access](/documentation/hql/properties/property-access) - Work with node properties
diff --git a/documentation/hql/vectors/searching.mdx b/documentation/hql/vectors/searching.mdx
@@ -1,12 +1,12 @@
 ---
-title: "Vector Search"
-description: "Search for vectors in your graph using cosine similarity."
+title: "Vector search"
+description: "How to perform vector similarity search in HelixDB using cosine similarity with code examples"
 icon: "magnifying-glass"
 ---
 
-## Search Vectors using `SearchV` &nbsp;
+## How do I search for similar vectors in HelixDB?
 
-Search for vectors in your graph.
+Use `SearchV` to find vectors similar to your query vector using cosine similarity.
 
 ```rust
 SearchV<Type>(vector, limit)
diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx
