Skip to content

graphrag/graphrag.github.io

Repository files navigation

GraphRAG Pattern Catalog

GraphRAG is a collection of RAG access patterns which target different layers of a knowledge graph.

It is available on https://graphrag.com

Contributing

Documentation Architecture

The documentation is structured in accordance with Diátaxis principles.

Consider this priority order of contribution:

  1. Glossary - everything gets a glossary entry
  • terse definitions of terminology and names
  • reference citations and attribution where appropriate
  • for example, define "vector embedding"
  • add the entry to /src/content/docs/appendices/glossary.mdx
  1. Reference - some glossary entries are expanded on with reference material
  • describe what something is
  • provide an illustration
  • reference related reference material :)
  • for example, describe what a vector embedding is
  • add a page under /src/content/docs/reference
  • use the template /src/content/docs/reference/template.md
  1. Guide - some reference material gets a how-to guide
  • process-oriented, how to achieve a specific goal
  • try to be implementation independent
  • reference relevant reference material
  • for example, how to perform vector similarity search
  • add a page under /src/content/docs/guides
  • use the template /src/content/docs/guides/template.md
  1. Tutorial - some how-to guides can be combined into tutorials
  • prefer to reference/link to tutorials where appropriate and available
  • walk through a complete example, including data
  • still try to be implementation independent
  • for example, chat with a PDF
  • add a page under /src/content/docs/tutorials
  • use the template /src/content/docs/tutorials/template.md

Research papers

Add relevant research papers from ArXiv by adding an entry to papers.json with the arxivid and an optional github org/repo combination.

Media assets

All diagrams are created using Excalidraw. Original source files are saved under /media and exported SVG images in /src/assets/images.


Sponsors

Neo4j

Thanks to Neo4j for sponsoring this work.

GraphRAG Pattern Catalog by Neo4j, Inc is licensed under CC BY 4.0