From cb6beedea22240adcfd7549face60fa06087c5dc Mon Sep 17 00:00:00 2001 From: Daniel Widgren Date: Wed, 20 May 2026 13:34:48 +0200 Subject: [PATCH] docs: drop sibling-lib name-drops from public surface MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README scope section named nova_audit and nova_vault as if they were tightly coupled. nova_vault doesn't exist yet (it's in internal plans), and even mentioning nova_audit by name reads like a coupling declaration which it isn't. Same fix applied to the moduledoc. CLAUDE.md keeps the named references — that's internal project context, not public-facing. --- README.md | 4 ++-- src/nova_storage.erl | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0bcf107..eca6c6b 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ The S3 adapter works against AWS, Cloudflare R2, Scaleway Object, Minio, B2. ## Scope `nova_storage` is intentionally narrow: bytes in, bytes out, signed URLs, -listing. Audit logs belong in `nova_audit`. Encryption-at-rest belongs in -`nova_vault`. Image transforms belong in a separate library. +listing. Audit logging, encryption-at-rest, and image transforms are +deliberately out of scope. ## Build diff --git a/src/nova_storage.erl b/src/nova_storage.erl index 1c84989..87a0065 100644 --- a/src/nova_storage.erl +++ b/src/nova_storage.erl @@ -2,8 +2,7 @@ -moduledoc """ Public API for the nova_storage library. -Object/file storage abstraction with pluggable adapters. Bytes-in / bytes-out; -encryption-at-rest is `nova_vault`'s job, audit is `nova_audit`'s. +Object/file storage abstraction with pluggable adapters. Bytes-in / bytes-out. ## Quick start @@ -35,8 +34,8 @@ encryption-at-rest is `nova_vault`'s job, audit is `nova_audit`'s. ## Stability `nova_storage` is NOT a dependency of nova core and must never become one. -Audit logging belongs in `nova_audit`. Encryption-at-rest belongs in -`nova_vault`. Image transforms belong in a separate library. +Audit logging, encryption-at-rest, and image transforms are deliberately +out of scope. """. -export([