Skip to content

docs: add vault concept diagram to README - #28

Merged
MugdhoAI merged 1 commit into
mainfrom
docs/vault-visual-hero
Oct 26, 2026
Merged

MugdhoAI merged 1 commit into
mainfrom
docs/vault-visual-hero

Conversation

@MugdhoAI

Copy link
Copy Markdown
Owner

Purpose

Add a compact visual at the top of the README that communicates the Vault API concept before readers reach the detailed architecture section.

Design

  • A central vault node represents the authenticated secret API.
  • A row of data elements suggests data moving through the service.
  • PostgreSQL is shown as the persistence layer, with the diagram explicitly labeling Fernet encryption at rest.
  • Use GitHub-rendered Mermaid rather than creating or adding another image asset.

Scope

README only. No application behavior, security guarantees, or deployment claims are changed.

@MugdhoAI
MugdhoAI merged commit 926309c into main Oct 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant