Skip to content

Commit

Permalink
fixed notation image links to be relative; added notation to front page
Browse files Browse the repository at this point in the history
  • Loading branch information
akollegger committed Sep 24, 2024
1 parent fceb93b commit e759455
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/content/docs/appendices/notation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ description: Compact notation for describing knowledge graph structures
---


![Graph pattern railroad diagram](/src/assets/images/railroad/pattern.svg)
![Graph pattern railroad diagram](../../../assets/images/railroad/pattern.svg)
*Graph pattern railroad diagram, a comma-separated list of PatternElement*

## About Notation

The GraphRAG pattern catalog uses a graph notation to describe logical graph structures
called patterns that are composed of nodes, relationships and subjects.

![Pattern Element](/src/assets/images/railroad/pattern-element.svg)
![Pattern Element](../../../assets/images/railroad/pattern-element.svg)
*PatternElement*

### Nodes

![Node is delimted by parentheses](/src/assets/images/railroad/node.svg)
![Node is delimted by parentheses](../../../assets/images/railroad/node.svg)
*Node is delimted by parentheses*

Nodes are individual records in a graph.
Expand Down Expand Up @@ -46,11 +46,11 @@ Nodes are individual records in a graph.

### Relationships

![Relationship starts with a node, then an arrow followed by a Path](/src/assets/images/railroad/relationship.svg)
![Relationship starts with a node, then an arrow followed by a Path](../../../assets/images/railroad/relationship.svg)
*Relationship starts with a Node, then an Arrow followed by a Path*
![Arrow looks like an arrow](/src/assets/images/railroad/arrow.svg)
![Arrow looks like an arrow](../../../assets/images/railroad/arrow.svg)
*Arrow looks like an arrow*
![Path is either a node or a Relationship (which starts with a Node)](/src/assets/images/railroad/path.svg)
![Path is either a node or a Relationship (which starts with a Node)](../../../assets/images/railroad/path.svg)
*Path is either a node or a Relationship (which starts with a Node)*

Relationships pair two nodes, a 'from' and a 'to' node.
Expand All @@ -63,7 +63,7 @@ Relationships pair two nodes, a 'from' and a 'to' node.

### Subjects

![Subject is surrounded by square brackets](/src/assets/images/railroad/subject.svg)
![Subject is surrounded by square brackets](../../../assets/images/railroad/subject.svg)
*Subject is delimted by square brackets*

Subjects compose multiple graph elements.
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,10 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
description="Common terminology and names used within GraphRAG."
href="/appendices/glossary"
/>
<LinkCard
title="Graph Notation"
description="Logical graph patterns using nodes, relationships and subjects."
href="/appendices/notation"
/>

</CardGrid>

0 comments on commit e759455

Please sign in to comment.