Skip to content

INDEX.md

Latest commit

 

History

History
137 lines (111 loc) · 4.26 KB

INDEX.md

File metadata and controls

137 lines (111 loc) · 4.26 KB

SharpCoreDB Documentation Index

Status: Active documentation set (v1.9.1)

1. Project Entry Points

  • ../README.md
  • README.md
  • FEATURE_MATRIX_v1.7.2.md
  • PROJECT_STATUS.md
  • CHANGELOG.md
  • CONTRIBUTING.md
  • UseCases.md
  • USER_MANUAL.md

2. Package Documentation (src)

  • ../src/SharpCoreDB/README.md
  • ../src/SharpCoreDB/NuGet.README.md
  • ../src/SharpCoreDB/PLATFORM_SUPPORT.md
  • ../src/SharpCoreDB.Server/README.md
  • ../src/SharpCoreDB.Server/NuGet.README.md
  • ../src/SharpCoreDB.Client/README.md
  • ../src/SharpCoreDB.Client/NuGet.README.md
  • ../src/SharpCoreDB.Data.Provider/README.md
  • ../src/SharpCoreDB.Data.Provider/NuGet.README.md
  • ../src/SharpCoreDB.EntityFrameworkCore/README.md
  • ../src/SharpCoreDB.EntityFrameworkCore/NuGet.README.md
  • ../src/SharpCoreDB.EntityFrameworkCore/USAGE.md
  • ../src/SharpCoreDB.Extensions/README.md
  • ../src/SharpCoreDB.Extensions/NuGet.README.md
  • ../src/SharpCoreDB.Analytics/README.md
  • ../src/SharpCoreDB.Analytics/NuGet.README.md
  • ../src/SharpCoreDB.VectorSearch/README.md
  • ../src/SharpCoreDB.VectorSearch/NuGet.README.md
  • ../src/SharpCoreDB.Graph/README.md
  • ../src/SharpCoreDB.Graph/NuGet.README.md
  • ../src/SharpCoreDB.Graph.Advanced/README.md
  • ../src/SharpCoreDB.Graph.Advanced/NuGet.README.md
  • ../src/SharpCoreDB.Distributed/README.md
  • ../src/SharpCoreDB.Distributed/NuGet.README.md
  • ../src/SharpCoreDB.Provider.Sync/README.md
  • ../src/SharpCoreDB.Provider.Sync/NuGet.README.md
  • ../src/SharpCoreDB.EventSourcing/README.md
  • ../src/SharpCoreDB.EventSourcing/NuGet.README.md
  • ../src/SharpCoreDB.Projections/README.md
  • ../src/SharpCoreDB.Projections/NuGet.README.md
  • ../src/SharpCoreDB.CQRS/README.md
  • ../src/SharpCoreDB.CQRS/NuGet.README.md
  • ../src/SharpCoreDB.Functional/README.md
  • ../src/SharpCoreDB.Functional.Dapper/README.md
  • ../src/SharpCoreDB.Functional.EntityFrameworkCore/README.md
  • ../src/SharpCoreDB.Identity/README.md
  • ../src/SharpCoreDB.Serilog.Sinks/README.md
  • ../src/SharpCoreDB.Serilog.Sinks/NuGet.README.md
  • ../src/SharpCoreDB.Serilog.Sinks/CHANGELOG.md

3. NuGet Publishing

  • ../.github/NUGET_PUBLISHING_GUIDE.md
  • ../.github/CI_CD_BEST_PRACTICES.md

4. Server Documentation

  • server/README.md
  • server/QUICKSTART.md
  • server/INSTALLATION.md
  • server/CLIENT_GUIDE.md
  • server/ADMIN_TOOLING_GUIDE.md
  • server/REST_API.md
  • server/BINARY_PROTOCOL_SPEC.md
  • server/CONFIGURATION_SCHEMA.md
  • server/SECURITY.md
  • server/SYSTEM_DATABASES_SECURITY.md

5. Storage and Engine Internals

  • scdb/README.md
  • scdb/README_INDEX.md
  • scdb/PRODUCTION_GUIDE.md
  • serialization/README.md
  • serialization/SERIALIZATION_AND_STORAGE_GUIDE.md
  • storage/QUICK_REFERENCE_v1.7.2.md
  • storage/METADATA_IMPROVEMENTS_v1.7.2.md
  • storage/SINGLE_FILE_SQL_LIMITATIONS.md

6. Engine Implementation Notes

  • internals/JOIN_IMPLEMENTATION.md
  • internals/SUBQUERY_IMPLEMENTATION.md
  • internals/SUBQUERY_INTEGRATION_GUIDE.md
  • internals/OPTIMIZER_ARCHITECTURE.md
  • internals/OPTIMIZER_GUIDE.md
  • internals/PROJECTIONS_OPEN_TELEMETRY_METRICS.md

7. GraphRAG, Vector, and Analytics

  • graphrag/00_START_HERE.md
  • graphrag/README.md
  • graphrag/GRAPH_RAG_SINGLE_SQL.md
  • graphrag/METRICS_AND_OBSERVABILITY_GUIDE.md
  • analytics/README.md
  • Vectors/README.md
  • performance/graphrag-performance-tuning.md

8. Distributed, Sync, and Migration

  • distributed/README.md
  • sync/README.md
  • migration/README.md
  • migration/MIGRATION_GUIDE.md
  • migration/FLUENTMIGRATOR_EMBEDDED_MODE_v1.7.0.md
  • migration/FLUENTMIGRATOR_SERVER_MODE_v1.7.0.md

9. Functional Programming & Null Safety

  • FUNCTIONAL_NULL_SAFETY.md
  • NULLABLE_VS_OPTIONAL_REBUTTAL.md

10. Benchmarks & Performance

  • BENCHMARK_RESULTS.md
  • QUERY_PLAN_CACHE.md
  • ../tests/SharpCoreDB.Benchmarks/FAIR_COMPARISON_TEMPLATE.md

11. Developer Standards

  • ../.github/CODING_STANDARDS_CSHARP14.md
  • ../.github/SIMD_STANDARDS.md

Documentation Governance

  • Files listed in this index are the maintained product documentation set.
  • Historical phase-design notes remain in internals/ for background context.
  • Superseded duplicates are removed instead of linked alongside canonical files.
  • All documentation is in English only.