Skip to content

Add Mermaid diagrams to the README and docs - #20

Merged
imanimanyara merged 1 commit into
mainfrom
docs/diagrams
Nov 14, 2026
Merged

imanimanyara merged 1 commit into
mainfrom
docs/diagrams

Conversation

@imanimanyara

Copy link
Copy Markdown
Member

Summary

Adds eight Mermaid diagrams to the README and docs, and a test that keeps them well-formed.

  • README.md: an overview. Owners and stores, the file and database layers, and the PHP, REST and console channels all go through the same actions.
  • docs/architecture.md has three diagrams:
    • read resolution: owner → parents → global, through database → runtime JSON → shipped file, then the definition default and the caller's default, with the cache inside the database layer;
    • the write pipeline;
    • the seven tables.
  • docs/recipes/moving-from-files-to-the-database.md: the promotion lifecycle.
  • docs/tools/approvals.md: the change-request states.
  • docs/tools/rest-api.md: a write request end to end, including ETag/If-Match and idempotency.
  • docs/tools/tenancy.md: how none, column and database isolate data.
  • docs/tools/commands.md: the doctor summary row now lists every check. The other recent features were checked against the code and were already documented accurately.

Guard

tests/Unit/MermaidDiagramsTest.php checks four things:

  • every mermaid block starts with a known diagram type;
  • quotes and brackets are balanced;
  • no sequence participant uses a reserved name;
  • it read at least 54 files and 8 diagrams.

It was proven red on an extra { and on participant Actor. Every block also parses with mermaid@11's own mermaid.parse().

Verification (local)

Pest: 713 passed. Pint: clean.

Copilot AI balanced review requested due to automatic review settings November 14, 2026 06:10

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@imanimanyara
imanimanyara merged commit 39e8ba1 into main Nov 14, 2026
14 checks passed
@imanimanyara
imanimanyara deleted the docs/diagrams branch November 14, 2026 06:13
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.

2 participants