update docs on new functionality (#150)

* update docs on new functionality

* update support

docs/blog/posts/introducing-graph-rag.md

@@ -1,6 +1,6 @@
 ---
 title: "Introducing Graph Retrievers: Smarter, Simpler Document Graphs for Vector Stores"
-sug: introducing-graph-rag
+slug: introducing-graph-rag
 description: "Announcing the first release of Graph Retrievers, a powerful graph traversal retriever for your vector store!"
 author: "Ben Chambers"
 date: 2025-01-31

docs/guide/adapters.md

@@ -1,22 +1,42 @@
+---
+i:
+    y: :material-check-circle:{.green}
+    n: :material-close-circle:{.red}
+    m: :material-alert-circle:{.yellow}
+---
+
 # Adapters
 
 Adapters allow `graph-retriever` to connect to specific vector stores.
 
-| Vector Store                   | Supported                       | Collection Support               | Optimized Adjacency             |
-| ------------------------------ | | | |
-| [DataStax Astra](#astra)       | :material-check-circle:{.green} | :material-check-circle:{.green}  | :material-check-circle:{.green} |
-| [OpenSearch](#opensearch)      | :material-check-circle:{.green} | :material-check-circle:{.green}  |                                 |
-| [Apache Cassandra](#cassandra) | :material-check-circle:{.green} | :material-alert-circle:{.yellow} |                                 |
-| [Chroma](#chroma)              | :material-check-circle:{.green} | :material-alert-circle:{.yellow} |                                 |
+| Vector Store                   | Supported | Collections | Dict-In-List | Nested Metadata | Optimized Adjacency |
+| ------------------------------ | :-------: | :---------: | :----------: | :-------------: | :-----------------: |
+| [DataStax Astra](#astra)       | {{ i.y }} | {{ i.y }}   | {{ i.y }}    | {{ i.y }}       | {{ i.y }}           |
+| [OpenSearch](#opensearch)      | {{ i.y }} | {{ i.y }}   | {{ i.n }}    | {{ i.n }}       | {{ i.n }}           |
+| [Apache Cassandra](#cassandra) | {{ i.y }} | {{ i.m }}   | {{ i.y }}    | {{ i.n }}       | {{ i.n }}           |
+| [Chroma](#chroma)              | {{ i.y }} | {{ i.m }}   | {{ i.y }}    | {{ i.n }}       | {{ i.n }}           |
 
 __Supported__
 
 : Indicates whether a given store is completely supported (:material-check-circle:{.green}) or has limited support (:material-alert-circle:{.yellow}).
 
-__Collection Support__
+__Collections__
 
 : Indicates whether the store supports lists in metadata values or not. Stores which do not support it directly (:material-alert-circle:{.yellow}) can be used by applying the [ShreddingTransformer][langchain_graph_retriever.transformers.ShreddingTransformer] document transformer to documents before writing, which spreads the items of the collection into multiple metadata keys.
 
+__Dict-In-List__
+
+: Indicates the store supports using a dict-value in a list for edges. For
+example, when using named-entity recognition, you may have `entities = [{"type":
+"PERSON", "entity": "Bell"}, ...]` and wish to link nodes with the same entity
+using an edge defined as `("entities", "entities")`.
+
+__Nested Metadata__
+
+: Whether edges can be defined using values of nested metadata. For example,
+`page_structure.section` to access the section ID stored in metadata as
+`metadata["page_structure"] = { "section": ... }`.
+
 __Optimized Adjacency__
 
 : Whether the store supports an optimized query for nodes adjacent to multiple edges. Without this optimization each edge must be queried separately. Stores that support the combined adjacent query perform much better, especially when retrieving large numbers of nodes and/or dealing with high connectivity.

docs/styles.css

@@ -7,6 +7,9 @@
 .green {
     color: #228B22;
 }
+.red {
+    color: #c83131;
+}
 .colab {
     color:  #F9AB00;
 }

mkdocs.yml

@@ -16,6 +16,8 @@ plugins:
 - social
 - search
 - blog
+- macros:
+    on_undefined: strict
 - mkdocs-jupyter:
     include_source: True
     remove_tag_config:

pyproject.toml

@@ -73,6 +73,7 @@ docs = [
     "pip>=25.0",
     "mkdocs-table-reader-plugin>=3.1.0",
     "ruff>=0.9.4",
+    "mkdocs-macros-plugin>=1.3.7",
 ]
 
 [tool.coverage.report]