Skip to content

LLM Support

TypeGraph documentation is available in formats optimized for Large Language Models (LLMs) following the llms.txt specification. All files are generated from the same source docs as the website.

For coding agents, use these files progressively:

  1. Start with /llms-small.txt for implementation and debugging tasks.
  2. Use /llms-full.txt only when you need deep reference content.
  3. Load /_llms-txt/examples.txt only when you need full end-to-end patterns.
FilePurposeSize
/llms.txtIndex with page titles, descriptions, and linksSmall
/llms-small.txtCore docs for implementation and debugging tasksMedium
/llms-full.txtComplete documentation in a single fileLarge
/_llms-txt/examples.txtComplete application examplesMedium

Use this in repository-level agent instruction files (AGENTS.md, CLAUDE.md, etc.):

TypeGraph (`@nicia-ai/typegraph`) is a TypeScript-first embedded knowledge graph
library with typed nodes, edges, queries, and schema management over SQLite and
PostgreSQL backends.
When working with TypeGraph code (graph definitions, node/edge schemas, store
operations, query builder, backend setup, or migrations):
1. Load https://typegraph.dev/llms-small.txt first.
2. Use https://typegraph.dev/llms-full.txt only for deep API/reference lookup.
3. Load https://typegraph.dev/_llms-txt/examples.txt only for end-to-end implementation patterns.
4. Prefer current API docs over inferred behavior from old snippets.