Reformat / cleanup
This commit is contained in:
34
README.md
34
README.md
@@ -1,16 +1,21 @@
|
||||
# CBDD
|
||||
|
||||
CBDD is an embedded, document-oriented database engine for .NET 10. It targets internal platform teams that need predictable ACID behavior, low-latency local persistence, and typed access patterns without running an external database server.
|
||||
CBDD is an embedded, document-oriented database engine for .NET 10. It targets internal platform teams that need
|
||||
predictable ACID behavior, low-latency local persistence, and typed access patterns without running an external database
|
||||
server.
|
||||
|
||||
## Purpose And Business Context
|
||||
|
||||
CBDD provides a local data layer for services and tools that need transactional durability, deterministic startup, and high-throughput reads/writes. The primary business outcome is reducing operational overhead for workloads that do not require a networked database cluster.
|
||||
CBDD provides a local data layer for services and tools that need transactional durability, deterministic startup, and
|
||||
high-throughput reads/writes. The primary business outcome is reducing operational overhead for workloads that do not
|
||||
require a networked database cluster.
|
||||
|
||||
## Ownership And Support
|
||||
|
||||
- Owning team: CBDD maintainers (repository owner: `@dohertj2`)
|
||||
- Primary support path: open a Gitea issue in this repository with labels `incident` or `bug`
|
||||
- Escalation path: follow [`docs/runbook.md`](docs/runbook.md) and page the release maintainer listed in the active release PR
|
||||
- Escalation path: follow [`docs/runbook.md`](docs/runbook.md) and page the release maintainer listed in the active
|
||||
release PR
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
@@ -22,6 +27,7 @@ CBDD has four primary layers:
|
||||
4. Source-generated mapping (`src/CBDD.SourceGenerators`)
|
||||
|
||||
Detailed architecture material:
|
||||
|
||||
- [`docs/architecture.md`](docs/architecture.md)
|
||||
- [`RFC.md`](RFC.md)
|
||||
- [`C-BSON.md`](C-BSON.md)
|
||||
@@ -36,34 +42,44 @@ Detailed architecture material:
|
||||
## Setup And Local Run
|
||||
|
||||
1. Clone the repository.
|
||||
|
||||
```bash
|
||||
git clone https://gitea.dohertylan.com/dohertj2/CBDD.git
|
||||
cd CBDD
|
||||
```
|
||||
|
||||
Expected outcome: local repository checkout with `CBDD.slnx` present.
|
||||
|
||||
2. Restore dependencies.
|
||||
|
||||
```bash
|
||||
dotnet restore
|
||||
```
|
||||
|
||||
Expected outcome: restore completes without package errors.
|
||||
|
||||
3. Build the solution.
|
||||
|
||||
```bash
|
||||
dotnet build CBDD.slnx -c Release
|
||||
```
|
||||
|
||||
Expected outcome: solution builds without compiler errors.
|
||||
|
||||
4. Run tests.
|
||||
|
||||
```bash
|
||||
dotnet test CBDD.slnx -c Release
|
||||
```
|
||||
|
||||
Expected outcome: all tests pass.
|
||||
|
||||
5. Run the full repository fitness check.
|
||||
|
||||
```bash
|
||||
bash scripts/fitness-check.sh
|
||||
```
|
||||
|
||||
Expected outcome: format, build, tests, coverage threshold, and package checks complete.
|
||||
|
||||
## Configuration And Secrets
|
||||
@@ -135,9 +151,12 @@ if (!result.Executed)
|
||||
|
||||
Common issues and remediation:
|
||||
|
||||
- Build/test environment failures: [`docs/troubleshooting.md#build-and-test-failures`](docs/troubleshooting.md#build-and-test-failures)
|
||||
- Data-file recovery procedures: [`docs/troubleshooting.md#data-file-and-recovery-issues`](docs/troubleshooting.md#data-file-and-recovery-issues)
|
||||
- Query/index behavior verification: [`docs/troubleshooting.md#query-and-index-issues`](docs/troubleshooting.md#query-and-index-issues)
|
||||
- Build/test environment failures: [
|
||||
`docs/troubleshooting.md#build-and-test-failures`](docs/troubleshooting.md#build-and-test-failures)
|
||||
- Data-file recovery procedures: [
|
||||
`docs/troubleshooting.md#data-file-and-recovery-issues`](docs/troubleshooting.md#data-file-and-recovery-issues)
|
||||
- Query/index behavior verification: [
|
||||
`docs/troubleshooting.md#query-and-index-issues`](docs/troubleshooting.md#query-and-index-issues)
|
||||
|
||||
## Change Governance
|
||||
|
||||
@@ -150,4 +169,5 @@ Common issues and remediation:
|
||||
|
||||
- Documentation home: [`docs/README.md`](docs/README.md)
|
||||
- Major feature inventory: [`docs/features/README.md`](docs/features/README.md)
|
||||
- Architecture decisions: [`docs/adr/0001-storage-engine-and-source-generation.md`](docs/adr/0001-storage-engine-and-source-generation.md)
|
||||
- Architecture decisions: [
|
||||
`docs/adr/0001-storage-engine-and-source-generation.md`](docs/adr/0001-storage-engine-and-source-generation.md)
|
||||
|
||||
Reference in New Issue
Block a user