Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 2.25 KB

EF_CORE_DOCUMENTATION_INDEX.md

File metadata and controls

77 lines (57 loc) · 2.25 KB

GraphRAG EF Core Integration - Documentation Index

Status: ✅ Phase 2 complete (Phase 3 prototype)
Last Updated: 2026-10-10 (links audited against the 2.1.0 tree)
Test Status: Run the MTP test host to validate locally — dotnet test is not supported in this repo (see docs/CONTRIBUTING.md)


Quick Links

Document Purpose Audience
LINQ_API_GUIDE.md LINQ API reference Developers
EF_CORE_COMPLETE_GUIDE.md Usage guide + architecture Developers, Tech Leads
EF_CORE_TEST_DOCUMENTATION.md Test suite documentation QA Engineers
00_START_HERE.md Entry point and current status Everyone

Audit note (2026-10-10): this index used to list three documents that were never written — EF_CORE_INTEGRATION_SUMMARY.md, TEST_EXECUTION_REPORT.md and COMPLETE_DELIVERY_SUMMARY.md. Their content lives in the guides below (architecture in EF_CORE_COMPLETE_GUIDE.md, the test inventory in EF_CORE_TEST_DOCUMENTATION.md, current status in 00_START_HERE.md and README.md).


LINQ API Guide

File: docs/graphrag/LINQ_API_GUIDE.md

Contents:

  • Quick start examples
  • API reference for all extension methods
  • Traversal strategy descriptions (BFS, DFS, Bidirectional, Dijkstra)
  • Generated SQL samples
  • Performance considerations
  • Error handling guide

EF Core Complete Guide

File: docs/graphrag/EF_CORE_COMPLETE_GUIDE.md

Contents:

  • Installation & setup
  • Quick start
  • Detailed API reference
  • SQL translation explanations
  • Usage patterns
  • Performance considerations

EF Core Integration Summary

Where: the architecture section of docs/graphrag/EF_CORE_COMPLETE_GUIDE.md

Contents:

  • Implementation overview
  • SQL translation flow
  • Key components and responsibilities

EF Core Test Documentation

File: docs/graphrag/EF_CORE_TEST_DOCUMENTATION.md

Contents:

  • Test suite coverage
  • Validation scenarios
  • How to run tests

Delivery Status

Where: 00_START_HERE.md and README.md

Contents:

  • Current implementation status
  • Implemented features
  • Planned next steps