docs: refresh for S3 storage migration and correct stale facts - #270
Merged
Conversation
Bring the docs in line with the current code after the NATS→S3 blob-storage migration, and fix unrelated staleness found while reviewing: Storage: - NATS no longer does object storage; documents/blobs live in an S3-compatible store (RustFS by default). Updated ARCHITECTURE, PROVIDERS, docs/README, README, CONTRIBUTING, and CHANGELOG accordingly. - SECURITY: add a "Document Encryption at Rest" section (blobs encrypted with the workspace key before the store; the store holds only ciphertext). Correctness fixes: - CHANGELOG: JWT is Ed25519 (EdDSA), not RSA; drop the non-existent "RAG pipeline with embeddings/semantic search"; complete the crate list. - CONTRIBUTING: Rust 1.95 (not 1.92); Apache-2.0 (not MIT); add the blob-store requirement. - ARCHITECTURE: add nvisy-s3/nvisy-object/nvisy-inference to the crate table; drop the wrong crate count; health endpoint reports four components (Postgres, NATS, blob store, webhook), not two. - docker/README: run `nvisy-cli` (not the non-existent `nvisy-server` binary); RustFS health probe is `/health/ready`. - nvisy-webhook README: the HTTP client is the `reqwest` module, not a `nvisy-reqwest` crate. Removed the "Context Files" feature description from ARCHITECTURE and INTELLIGENCE — no such model/handler/table/route exists (tracked in #269). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018bKk1YEG4tZ69jzYVQvQL8
martsokha
added
docs
|
Warning Review limit reachedNext included review available in 6 minutes. View limit detailsLimit details: You’ve used the included review currently available. Your 62 included PR review attempts over the past 7 days set your current allowance at 1 review per hour. Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (10)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes the documentation after the NATS→S3 blob-storage migration (#268), plus a full accuracy pass that turned up several unrelated stale facts.
Storage (the migration)
ARCHITECTURE.md,PROVIDERS.md,docs/README.md, top-levelREADME.md,CONTRIBUTING.md,CHANGELOG.md.SECURITY.md: added a Document Encryption at Rest section — blob bytes are encrypted with the per-workspace key before the store, so the store only ever holds ciphertext (the backend choice never widens the trust surface).Correctness fixes found during review
CHANGELOG.md: JWT signing is Ed25519 (EdDSA), not RSA; removed the non-existent RAG/embeddings/semantic-search feature; completed the crate list (was 6, workspace has 9).CONTRIBUTING.md: Rust 1.95 (was 1.92, perCargo.toml); Apache-2.0 (was MIT); added the blob-store requirement.ARCHITECTURE.md: addednvisy-s3/nvisy-object/nvisy-inferenceto the crate table; dropped the hardcoded crate count; the/health/endpoint reports four components (Postgres, NATS, blob store, webhook), not two.docker/README.md: dev quick-start runsnvisy-cli(there is nonvisy-serverbinary); RustFS health probe is/health/ready.crates/nvisy-webhook/README.md: the HTTP client is thereqwestmodule, not anvisy-reqwestcrate.Removed: "Context Files"
ARCHITECTURE.mdandINTELLIGENCE.mddescribed a Context Files feature (encrypted JSON context blobs + a CRUD/multipart API) that has no backing code — no model, table, handler, or route. Removed the references; the doc↔code gap is tracked in #269 (decide whether it was superseded by Policies or is still to be built).Notes
CLAUDE.mdhad the same stale crate list / tech-stack; it is gitignored, so it was fixed locally but is not part of this PR.🤖 Generated with Claude Code