docs: rewrite for users — drop internal infra context
README + supporting docs were written for ourselves (deployment paths,
internal product comparisons, internal task lists, build pipeline
artifacts) instead of for users of the software. This pass refocuses
them on what the software is, how to install, configure, and use it.
- README.md: full rewrite. New shape — What it does / Architecture /
Build / Run / Configuration / MCP tools / Security model / Status /
License / Dependencies. Drops the internal "why we built it"
narrative, drops phase-status claims that drifted stale, drops
internal deployment paths.
- ROADMAP.md: deleted. Was an internal task-list with [x]/[ ] items
showing incremental private development. The README's Status
section now communicates what's actually shipped.
- docs/architecture.md: scrub cross-project comparisons referencing
unrelated internal Sulkta codebases.
- aiken-escrow/README.md: drop reference to a non-existent spec file;
rewrite the Status checklist to reflect what's actually done
rather than what was open at the time of writing.
- audits/2026-05-09-escrow-e2e.md: scrub internal image names +
container paths; the audit findings (chain hashes, validator hash,
what each tx proved) are the public-useful part and stay.
- audits/2026-05-09-escrow-internal-audit.md: drop references to
feature-flag-gated branches that no longer exist.
- Dockerfile: drop the dead `escrow_wip surface` phrase from comments.
- Cargo.toml: drop the cross-project comparison comment that named
an unrelated internal service.
- crates/aldabra-{core,dao}: scrub internal preprod-test naming from
source comments — same technical content, generic phrasing.
This commit is contained in:
parent
bc538a71fb
commit
93f11ecef0
10 changed files with 166 additions and 222 deletions
|
|
@ -19,9 +19,9 @@ auditable in isolation.
|
|||
loading, MCP transport, tool registration, error mapping. The
|
||||
thinnest layer.
|
||||
|
||||
This is the same pattern PetalParse + Cauldron use with their
|
||||
`<service>-core` / `<service>-web` split. Consistent across Sulkta
|
||||
codebases.
|
||||
The split is a deliberate auditability + replaceability boundary —
|
||||
each crate has a single responsibility and the security-sensitive
|
||||
one has no I/O dependencies.
|
||||
|
||||
## Threat model
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue