Make the key model and the main flows easier to follow by adding Mermaid diagrams to the documentation.

Config

mkdocs.yml enables the mermaid custom fence under pymdownx.superfences (mirroring the webform/webdav setup already proven on the d.o pages build), so fenced mermaid blocks render as diagrams.

Diagrams added

  • concepts.md: the three-tier key hierarchy and the passphrase two-layer wrap (converted from the existing ASCII art), plus a new unlock-flow sequence (derive with Argon2id, unwrap, hold the Subject KEK in a sliding-TTL session).
  • cross-site-api.md: the consumer/vault architecture (converted from ASCII) and a cross-site read sequence (OAuth token plus opaque handle, the ConsumerApi grant/trust gate, authorized vs uniform 403).
  • dormant-vaults.md: the active to warned to erased lifecycle as a state diagram, including the reset-on-activity edge.
  • multi-tenancy.md: per-tenant isolation (one account, two independently-encrypted vaults under separate Master KEKs).

Command and config snippets stay as code; only genuine diagrams were added. Every block was validated against the mermaid engine, and mkdocs build --strict passes.

Issue fork pdv-3596698

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

mably created an issue. See original summary.

  • mably committed 7ad38b20 on 1.x
    task: #3596698 Docs: add Mermaid diagrams for the key model and main...
mably’s picture

Status: Active » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.