Files
nuncio/docs/Home.md
James Maes 514f8eb15b docs: audit pass — align all docs and repo meta with reality
Sweep every README/doc for accuracy and remove fabricated or stale content:
- README/CLAUDE: add the live roadmap-page link and a rule to keep the rendered
  page in sync with docs/ROADMAP.md; fix the stale cov alias and the
  already-moved-shells note.
- .github/CONTRIBUTING+SECURITY: drop the fabricated nuncio.mx site link and the
  aspirational release/security claims; state honest pre-alpha status.
- docs/RUNNING, DEVELOPING, ARCHITECTURE, BACKLOG, Home, NSQL spec, corruption
  notes, proto/README: correct crate count/list, service list, CLI flags, phase
  status, and remove claims of unshipped/removed things (IPC-as-current,
  hardcoded-keys, unwired engines); mark superseded api-surface-draft historical.
- Remove the fabricated benchmark baked into nsql_pipeline.svg and delete the
  orphaned ipc_sequence.svg (depicted the removed IPC with a fake timing).
2026-07-28 10:49:48 -05:00

34 lines
1.6 KiB
Markdown

# Nuncio Wiki
**A local-first mail, calendar, and contacts engine in Rust.**
> **Status: pre-alpha, under active reconstruction (2026-07-26).** Nuncio began as
> an AI-generated proof of concept that a forensic assessment found to be largely
> non-functional, with substantially fabricated documentation. It is being rebuilt
> engine-first. Older wiki pages claiming completed features, benchmarks, or
> "100% parity" were removed. **Nothing here should be read as a shipped feature
> unless the roadmap says so.**
## Start here
- **[Roadmap](ROADMAP)** — the authoritative plan and target architecture.
- **[Backlog](BACKLOG)** — engineering-ready Phase 0 / Phase 1 stories.
- **[Architecture](ARCHITECTURE)** — technical architecture (target + current state).
- **[ADR 0001 — Engine-first gRPC architecture](adr/0001-engine-first-grpc-architecture)** — the governing decision.
## Reference (real subsystems, with status caveats)
- **[NSQL Filter Language](NSQL-Filter-Language-Specification)** — the declarative
filter language (parser/validator/engine are real and account scoping is
correct; wiring matched rules to actually fire actions against live mail is
roadmap M4).
- **[Database Self-Healing](Database-Corruption-Self-Healing)** — corruption
detection and recovery (real; the two defects tracked for Phase 1 are fixed).
## The short version
The daemon (`nunciod`) is the product: it owns all state, credentials, and
protocol logic, and publishes a versioned gRPC API over loopback. User interfaces
are separate native clients that consume that API. Parity across clients is a
property of the published contract, not a matter of discipline.