Merge pull request #38 from FalkorDB/docs-seo

Add h1 to all pages and set unique description
FalkorDB · Apr 24, 2024 · c80a245 · c80a245
2 parents 4b5032b + 413a031
commit c80a245
Show file tree

Hide file tree

Showing 48 changed files with 85 additions and 48 deletions.
diff --git a/References.md b/References.md
@@ -4,6 +4,8 @@ description: Learn more about the Technology behind FalkorDB
 nav_order: 998
 ---
 
+# References
+
 * [FalkorDB Blog](https://www.falkordb.com/blog)
 
 * Video

diff --git a/bolt_support.md b/bolt_support.md
@@ -4,13 +4,13 @@ nav_order: 10
 description: "Connecting to FalkorDB using BOLT protocol."
 ---
 
-## [EXPERIMENTAL] BOLT protocol support for FalkorDB 
+# [EXPERIMENTAL] BOLT protocol support for FalkorDB 
 
 FalkorDB provides an experimental support for querying using BOLT drivers.
 We intend to extend the support in the future versions, the current version is not meant to be used in production.
 This guide will walk you through the process of connecting to FalkorDB using the [BOLT protocol](https://en.wikipedia.org/wiki/Bolt_(network_protocol))
 
-### Prerequisites
+## Prerequisites
 
 Before you begin, ensure that you have a FalkorDB instance up and running.
 You can use our Docker image for this purpose.
@@ -19,7 +19,7 @@ You can use our Docker image for this purpose.
 docker run -p 6379:6379 -p 7678:7678 -p 3000:3000 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="BOLT_PORT 7678" --rm falkordb/falkordb:latest
 ```
 
-#### Ports 
+### Ports 
 - 6379 - FalkorDB
 - 7678 - Bolt
 - 3000 - Falkor-Browser
@@ -30,7 +30,7 @@ Additionally, install the necessary BOLT drivers:
 pip install neo4j
 ```
 
-### Step 1: Create a `main.py` File
+## Step 1: Create a `main.py` File
 
 Create a main.py file with the following content and adjust the connection uri, authentication parameters and database name according to your FalkorDB setup. This script demonstrates a simple query that returns the numbers from 1 to 10. Customize the query as needed for your specific use case.
 
@@ -48,7 +48,7 @@ for record in records:
     print(record["i"])
 ```
 
-### Step 2: Run the script
+## Step 2: Run the script
 
 Execute the script by running the following command in your terminal:
 

diff --git a/clients.md b/clients.md
@@ -5,7 +5,7 @@ description: >
     FalkorDB Clients
 ---
 
-## Official Clients
+# Official Clients
 
 | Project                                                   | Language   | License    | Author                                      | Package                                  |
 | --------------------------------------------------------- | ---------- | ---------- | ------------------------------------------- | ---------------------------------------- |

diff --git a/commands/graph.config-get.md b/commands/graph.config-get.md
@@ -5,6 +5,8 @@ description: >
 parent: "Commands"
 ---
 
+# GRAPH.CONFIG-GET
+
 Retrieves the current value of a FalkorDB configuration parameter.
 
 FalkorDB configuration parameters are detailed [here](/configuration).

diff --git a/commands/graph.config-set.md b/commands/graph.config-set.md
@@ -5,6 +5,8 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.CONFIG-SET
+
 Set the value of a FalkorDB configuration parameter.
 
 Values set using `GRAPH.CONFIG SET` are not persisted after server restart.

diff --git a/commands/graph.constraint-create.md b/commands/graph.constraint-create.md
@@ -5,6 +5,7 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.CONSTRAINT CREATE
 
 ---
 syntax: |

diff --git a/commands/graph.constraint-drop.md b/commands/graph.constraint-drop.md
@@ -5,6 +5,7 @@ description: >
 parent: "Commands"
 ---
 
+# GRAPH.CONSTRAINT DROP
 
 ---
 syntax: |

diff --git a/commands/graph.copy.md b/commands/graph.copy.md
@@ -5,6 +5,8 @@ description: >
 parent: "Commands"
 ---
 
+# GRAPH.COPY
+
 Usage: `GRAPH.COPY <src> <dest>`
 
 The `GRAPH.COPY` command creates a copy of a graph, while the copy is performed

diff --git a/commands/graph.delete.md b/commands/graph.delete.md
@@ -6,6 +6,8 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.DELETE
+
 Completely removes the graph and all of its entities.
 
 Arguments: `Graph name`

diff --git a/commands/graph.explain.md b/commands/graph.explain.md
@@ -6,6 +6,8 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.EXPLAIN
+
 Constructs a query execution plan but does not run it. Inspect this execution plan to better
 understand how your query will get executed.
 

diff --git a/commands/graph.list.md b/commands/graph.list.md
@@ -6,6 +6,8 @@ description: >
 parent: "Commands"
 ---
 
+# GRAPH.LIST
+
 Lists all graph keys in the keyspace.
 
 ```sh

diff --git a/commands/graph.profile.md b/commands/graph.profile.md
@@ -6,6 +6,8 @@ description: >
 parent: "Commands"
 ---
 
+# GRAPH.PROFILE
+
 Executes a query and produces an execution plan augmented with metrics for each operation's execution.
 
 Arguments: `Graph name, Query`

diff --git a/commands/graph.query.md b/commands/graph.query.md
@@ -6,6 +6,7 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.QUERY
 
 Executes the given query against a specified graph.
 

diff --git a/commands/graph.ro_query.md b/commands/graph.ro_query.md
@@ -6,6 +6,8 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.RO_QUERY
+
 Executes a given read only query against a specified graph.
 
 Arguments: `Graph name, Query, Timeout [optional]`

diff --git a/commands/graph.slowlog.md b/commands/graph.slowlog.md
@@ -5,6 +5,8 @@ description: >
 parent: "Commands"    
 ---
 
+# GRAPH.SLOWLOG
+
 Returns a list containing up to 10 of the slowest queries issued against the given graph ID.
 
 Each item in the list has the following structure:

diff --git a/commands/index.md b/commands/index.md
@@ -5,13 +5,13 @@ nav_order: 3
 has_children: true
 ---
 
-## Overview
+# Commands
 
-### FalkorDB Features
+## FalkorDB Features
 
 FalkorDB exposes graph database functionality within Redis using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval.
 
-### FalkorDB API
+## FalkorDB API
 
 Command details can be retrieved by filtering for the [module](/commands/?group=graph) or for a specific command, e.g., `GRAPH.QUERY`.
 The details include the syntax for the commands, where:

diff --git a/configuration.md b/configuration.md
@@ -5,6 +5,8 @@ description: >
     FalkorDB supports multiple module configuration parameters. 
 ---
 
+# Configuration
+
 FalkorDB supports [Redis configuration](https://redis.io/docs/management/config/) and multiple module configuration parameters. 
 Some of these parameters can only be set at load-time, while other parameters can be set either on load-time or on run-time.
 

diff --git a/cypher/algorithms.md b/cypher/algorithms.md
@@ -2,7 +2,7 @@
 title: "Algorithms"
 nav_order: 19
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    FalkorDB supported algorithms like BFS.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/call.md b/cypher/call.md
@@ -2,7 +2,7 @@
 title: "CALL"
 nav_order: 16
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The CALL {} (subquery) clause allows local execution of subqueries, which opens the door for many comfortable and efficient actions on a graph.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/create.md b/cypher/create.md
@@ -2,7 +2,7 @@
 title: "CREATE"
 nav_order: 8
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    CREATE is used to introduce new nodes and relationships.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/cypher.md b/cypher/cypher.md
@@ -2,7 +2,7 @@
 title: "Cypher Language"
 nav_order: 7
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Cypher Language documentation 
 has_children: true
 ---
 

diff --git a/cypher/delete.md b/cypher/delete.md
@@ -2,7 +2,7 @@
 title: "DELETE"
 nav_order: 9
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    DELETE is used to remove both nodes and relationships.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/foreach.md b/cypher/foreach.md
@@ -2,7 +2,7 @@
 title: "FOREACH"
 nav_order: 15
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The FOREACH clause feeds the components of a list to a sub-query comprised of updating clauses only
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/functions.md b/cypher/functions.md
@@ -2,7 +2,7 @@
 title: "Functions"
 nav_order: 17
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Information on all supported functions from the Cypher query language
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/index.md b/cypher/index.md
@@ -2,7 +2,7 @@
 title: "Indexing"
 nav_order: 20
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    FalkorDB supports single-property indexes for node labels and for relationship type. String, numeric, and geospatial data types can be indexed.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/known_limitations.md b/cypher/known_limitations.md
@@ -1,10 +1,12 @@
 ---
 title: "Known limitations"
-description: ""
+description: "FalkorDB Known limitations"
 nav_order: 1000
 parent: "Cypher Language"
 ---
 
+# Known limitations
+
 ## Relationship uniqueness in patterns
 
 When a relation in a match pattern is not referenced elsewhere in the query, FalkorDB will only verify that at least one matching relation exists (rather than operating on every matching relation).

diff --git a/cypher/limit.md b/cypher/limit.md
@@ -2,7 +2,7 @@
 title: "LIMIT"
 nav_order: 7
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Can use the limit clause to limit the number of records returned by a query
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/match.md b/cypher/match.md
@@ -2,7 +2,7 @@
 title: "MATCH"
 nav_order: 1
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Match describes the relationship between queried entities, using ascii art to represent pattern(s) to match against.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/merge.md b/cypher/merge.md
@@ -2,7 +2,7 @@
 title: "MERGE"
 nav_order: 11
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The MERGE clause ensures that a path exists in the graph (either the path already exists, or it needs to be created).
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/optional_match.md b/cypher/optional_match.md
@@ -2,7 +2,7 @@
 title: "OPTIONAL MATCH"
 nav_order: 2
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The OPTIONAL MATCH clause is a MATCH variant that produces null values for elements that do not match successfully, rather than the all-or-nothing logic for patterns in MATCH clauses.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/order_by.md b/cypher/order_by.md
@@ -2,7 +2,7 @@
 title: "ORDER BY"
 nav_order: 5
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Order by specifies that the output be sorted and how.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/procedures.md b/cypher/procedures.md
@@ -2,7 +2,7 @@
 title: "Procedures"
 nav_order: 18
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Procedures calling using with CALL and YIELD.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/return.md b/cypher/return.md
@@ -2,7 +2,7 @@
 title: "RETURN"
 nav_order: 4
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Return defines which properties the returned result-set will contain.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/set.md b/cypher/set.md
@@ -2,7 +2,7 @@
 title: "SET"
 nav_order: 10
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    SET is used to create or update properties on nodes and relationships.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/skip.md b/cypher/skip.md
@@ -2,7 +2,7 @@
 title: "SKIP"
 nav_order: 6
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The optional skip clause allows a specified number of records to be omitted from the result set.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/union.md b/cypher/union.md
@@ -2,7 +2,7 @@
 title: "UNION"
 nav_order: 13
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The UNION clause is used to combine the result of multiple queries.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/unwind.md b/cypher/unwind.md
@@ -2,7 +2,7 @@
 title: "UNWIND"
 nav_order: 14
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The UNWIND clause breaks down a given list into a sequence of records; each contains a single element in the list.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/where.md b/cypher/where.md
@@ -2,7 +2,7 @@
 title: "WHERE"
 nav_order: 3
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    Optional clause used to filter results based on predicates.
 parent: "Cypher Language"
 ---
 

diff --git a/cypher/with.md b/cypher/with.md
@@ -2,7 +2,7 @@
 title: "WITH"
 nav_order: 12
 description: >
-    FalkorDB implements a subset of the Cypher language, which is growing as development continues.
+    The WITH clause allows parts of queries to be independently executed and have their results handled uniquely.
 parent: "Cypher Language"
 ---