Skip to content

Commit 70d8762

Browse files
author
MPCoreDeveloper
committed
Refresh docs and add GraphRAG coverage
1 parent 7bfbd5a commit 70d8762

16 files changed

Lines changed: 429 additions & 3130 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,11 +253,14 @@ dotnet add package SharpCoreDB.Functional.EntityFrameworkCore --version 1.7.0
253253

254254
- Documentation hub: `docs/INDEX.md`
255255
- Project docs index: `docs/README.md`
256+
- Feature matrix: `docs/FEATURE_MATRIX_v1.7.0.md`
256257
- Server docs: `docs/server/README.md`
257258
- Server quick start: `docs/server/QUICKSTART.md`
258-
- Server install/config: `docs/server/INSTALLATION.md`, `docs/server/CONFIGURATION_SCHEMA.md`
259-
- Security hardening: `docs/server/SECURITY.md`
259+
- GraphRAG docs: `docs/graphrag/00_START_HERE.md`
260+
- EF Core provider docs: `src/SharpCoreDB.EntityFrameworkCore/README.md`, `src/SharpCoreDB.EntityFrameworkCore/USAGE.md`
261+
- Optional architecture packages: `src/SharpCoreDB.EventSourcing/README.md`, `src/SharpCoreDB.Projections/README.md`, `src/SharpCoreDB.CQRS/README.md`
260262
- Implementation audit and status: `docs/IMPLEMENTATION_AUDIT_v1.7.0.md`, `docs/PROJECT_STATUS.md`
263+
- Package publish/readme guidance: `nuget/README.md`, `NuGet.README.md`
261264

262265
---
263266

docs/INDEX.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,42 @@
1515
## 2. Package Documentation (src)
1616

1717
- `../src/SharpCoreDB/README.md`
18+
- `../src/SharpCoreDB/NuGet.README.md`
1819
- `../src/SharpCoreDB.Server/README.md`
20+
- `../src/SharpCoreDB.Server/NuGet.README.md`
1921
- `../src/SharpCoreDB.Client/README.md`
22+
- `../src/SharpCoreDB.Client/NuGet.README.md`
23+
- `../src/SharpCoreDB.Data.Provider/README.md`
24+
- `../src/SharpCoreDB.Data.Provider/NuGet.README.md`
25+
- `../src/SharpCoreDB.EntityFrameworkCore/README.md`
26+
- `../src/SharpCoreDB.EntityFrameworkCore/USAGE.md`
27+
- `../src/SharpCoreDB.EntityFrameworkCore/NuGet.README.md`
28+
- `../src/SharpCoreDB.Extensions/README.md`
29+
- `../src/SharpCoreDB.Extensions/NuGet.README.md`
2030
- `../src/SharpCoreDB.Analytics/README.md`
31+
- `../src/SharpCoreDB.Analytics/NuGet.README.md`
2132
- `../src/SharpCoreDB.VectorSearch/README.md`
33+
- `../src/SharpCoreDB.VectorSearch/NuGet.README.md`
2234
- `../src/SharpCoreDB.Graph/README.md`
35+
- `../src/SharpCoreDB.Graph/NuGet.README.md`
2336
- `../src/SharpCoreDB.Graph.Advanced/README.md`
37+
- `../src/SharpCoreDB.Graph.Advanced/NuGet.README.md`
2438
- `../src/SharpCoreDB.Distributed/README.md`
39+
- `../src/SharpCoreDB.Distributed/NuGet.README.md`
2540
- `../src/SharpCoreDB.Provider.Sync/README.md`
41+
- `../src/SharpCoreDB.Provider.Sync/NuGet.README.md`
2642
- `../src/SharpCoreDB.EventSourcing/README.md`
43+
- `../src/SharpCoreDB.EventSourcing/NuGet.README.md`
2744
- `../src/SharpCoreDB.Projections/README.md`
45+
- `../src/SharpCoreDB.Projections/NuGet.README.md`
2846
- `../src/SharpCoreDB.CQRS/README.md`
47+
- `../src/SharpCoreDB.CQRS/NuGet.README.md`
2948
- `../src/SharpCoreDB.Functional/README.md`
49+
- `../src/SharpCoreDB.Functional.Dapper/README.md`
50+
- `../src/SharpCoreDB.Functional.EntityFrameworkCore/README.md`
51+
- `../src/SharpCoreDB.Identity/README.md`
52+
- `../src/SharpCoreDB.Serilog.Sinks/README.md`
53+
- `../src/SharpCoreDB.Serilog.Sinks/NuGet.README.md`
3054

3155
## 3. Server Documentation
3256

@@ -55,6 +79,8 @@
5579

5680
- `graphrag/00_START_HERE.md`
5781
- `graphrag/README.md`
82+
- `graphrag/GRAPH_RAG_SINGLE_SQL.md`
83+
- `graphrag/METRICS_AND_OBSERVABILITY_GUIDE.md`
5884
- `analytics/README.md`
5985
- `Vectors/README.md`
6086
- `performance/graphrag-performance-tuning.md`
@@ -68,6 +94,8 @@
6894
- `migration/FLUENTMIGRATOR_EMBEDDED_MODE_v1.7.0.md`
6995
- `migration/FLUENTMIGRATOR_SERVER_MODE_v1.7.0.md`
7096

71-
## Canonical Documentation Rule
97+
## 7. Documentation Governance
7298

73-
When duplicate or historical status/planning documents exist, the files listed in this index are the canonical references.
99+
- Files listed in this index are the maintained product documentation set.
100+
- Historical phase-design notes may remain in feature folders for background context, but they are archival references unless they also appear in this index.
101+
- Superseded duplicates should be removed instead of linked alongside the canonical files.

docs/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This folder contains the maintained documentation set for SharpCoreDB (`v1.7.0`)
1010
- `IMPLEMENTATION_AUDIT_v1.7.0.md` - Repository-wide implementation audit.
1111
- `../README.md` - Product overview and quick start.
1212

13-
## Core Areas
13+
## Maintained documentation areas
1414

1515
- `server/` - Server operation, security, APIs, and protocols.
1616
- `sql/` - SQL dialect capabilities, extensions, and compatibility guidance.
@@ -23,16 +23,22 @@ This folder contains the maintained documentation set for SharpCoreDB (`v1.7.0`)
2323
- `sync/` - Dotmim.Sync provider usage.
2424
- `migration/` - Migration and interoperability guides.
2525

26+
## Current package entry points
27+
28+
- Core: `../src/SharpCoreDB/README.md`, `../src/SharpCoreDB/NuGet.README.md`
29+
- Data access: `../src/SharpCoreDB.Data.Provider/README.md`, `../src/SharpCoreDB.EntityFrameworkCore/README.md`, `../src/SharpCoreDB.EntityFrameworkCore/USAGE.md`, `../src/SharpCoreDB.Extensions/README.md`
30+
- Analytics and search: `../src/SharpCoreDB.Analytics/README.md`, `../src/SharpCoreDB.VectorSearch/README.md`, `../src/SharpCoreDB.Graph/README.md`, `../src/SharpCoreDB.Graph.Advanced/README.md`
31+
- Server and clients: `../src/SharpCoreDB.Server/README.md`, `../src/SharpCoreDB.Client/README.md`
32+
- Optional architecture modules: `../src/SharpCoreDB.EventSourcing/README.md`, `../src/SharpCoreDB.Projections/README.md`, `../src/SharpCoreDB.CQRS/README.md`
33+
- Optional functional adapters: `../src/SharpCoreDB.Functional/README.md`, `../src/SharpCoreDB.Functional.Dapper/README.md`, `../src/SharpCoreDB.Functional.EntityFrameworkCore/README.md`
34+
- Additional integrations: `../src/SharpCoreDB.Identity/README.md`, `../src/SharpCoreDB.Serilog.Sinks/README.md`, `../src/SharpCoreDB.Provider.Sync/README.md`
35+
2636
## SQL extension docs (v1.7.0)
2737

2838
- `sql/SQL_DIALECT_EXTENSIONS_v1.7.0.md` - SharpCoreDB-specific SQL extensions including `GRAPH_RAG`, `OPTIONALLY`, and `IS SOME`/`IS NONE`.
2939
- `graphrag/GRAPH_RAG_SINGLE_SQL.md` - Single-statement GraphRAG SQL syntax and DI integration.
3040
- `functional/OPTIONALLY_SQL_OPTION_SUPPORT_v1.7.0.md` - Option<T> mapping semantics and usage patterns.
3141

32-
## Package Documentation
33-
34-
Per-package docs are maintained in `src/*/README.md` and `src/*/NuGet.README.md`, aligned to `v1.7.0`.
35-
36-
## Cleanup Policy
42+
## Cleanup policy
3743

38-
Obsolete phase-status, kickoff, and superseded planning docs are removed during maintenance. Historical snapshots are not canonical product docs.
44+
Obsolete phase-status, kickoff, duplicate, and superseded planning docs are removed during maintenance. Historical snapshots are not canonical product docs unless they are explicitly linked from `INDEX.md`.

docs/graphrag/00_START_HERE.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,34 @@ This page is the entry point for active GraphRAG documentation (`v1.7.0`).
44

55
## v1.7.0 focus
66

7-
- `SharpCoreDB.Graph.Advanced` is the primary advanced graph analytics + GraphRAG package
8-
- Pair with `SharpCoreDB.Graph` for traversal/pathfinding and `SharpCoreDB.VectorSearch` for semantic retrieval
9-
- See `../FEATURE_MATRIX_v1.7.0.md` for package-level capability mapping
7+
- `SharpCoreDB.Graph.Advanced` is the primary advanced graph analytics + GraphRAG package.
8+
- Pair it with `SharpCoreDB.Graph` for traversal/pathfinding and `SharpCoreDB.VectorSearch` for semantic retrieval.
9+
- Use `../FEATURE_MATRIX_v1.7.0.md` for package-level capability mapping across the full ecosystem.
1010

11-
## Recommended Reading Order
11+
## Recommended reading order
1212

13-
1. `LINQ_API_GUIDE.md` - Practical API-first usage.
14-
2. `EF_CORE_COMPLETE_GUIDE.md` - End-to-end EF Core integration guide.
15-
3. `CUSTOM_HEURISTICS_GUIDE.md` - Heuristic extension patterns.
16-
4. `METRICS_AND_OBSERVABILITY_GUIDE.md` - Telemetry and operational visibility.
17-
5. `QUERY_PLAN_CACHING.md` - Query planning and caching behavior.
18-
6. `README.md` - GraphRAG area overview.
13+
1. `README.md` - Current package and capability overview.
14+
2. `GRAPH_RAG_SINGLE_SQL.md` - Single-statement GraphRAG SQL workflow.
15+
3. `LINQ_API_GUIDE.md` - API-first usage for graph traversal and integration patterns.
16+
4. `EF_CORE_COMPLETE_GUIDE.md` - End-to-end EF Core integration guidance.
17+
5. `CUSTOM_HEURISTICS_GUIDE.md` - Heuristic extension patterns.
18+
6. `METRICS_AND_OBSERVABILITY_GUIDE.md` - Telemetry and operational visibility.
19+
7. `QUERY_PLAN_CACHING.md` - Query planning and caching behavior.
1920

20-
## Technical Background
21+
## Validation and testing
22+
23+
- `EF_CORE_TEST_DOCUMENTATION.md`
24+
- `EF_CORE_DOCUMENTATION_INDEX.md`
25+
26+
## Archival technical background
27+
28+
The following phase-design notes are retained only for historical design context and are not the maintained starting point for feature documentation:
2129

2230
- `PHASE4_DESIGN.md`
2331
- `PHASE5_1_FEATURE_GUIDE.md`
2432
- `PHASE6_DESIGN.md`
2533
- `PHASE6_3_DESIGN.md`
2634

27-
## Validation and Testing
28-
29-
- `EF_CORE_TEST_DOCUMENTATION.md`
30-
- `EF_CORE_DOCUMENTATION_INDEX.md`
31-
3235
## Notes
3336

34-
Historical kickoff/progress/completion snapshots were removed as obsolete and are no longer part of the maintained documentation path.
37+
Historical kickoff, status, and duplicate progress notes should be removed during documentation maintenance instead of being added to the canonical reading path.

0 commit comments

Comments
 (0)