Repository navigation
Add Mermaid diagrams to the README and docs - #20
Merged
Merged
Conversation
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
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.
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.mdhas three diagrams: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-Matchand idempotency.docs/tools/tenancy.md: hownone,columnanddatabaseisolate data.docs/tools/commands.md: thedoctorsummary row now lists every check. The other recent features were checked against the code and were already documented accurately.Guard
tests/Unit/MermaidDiagramsTest.phpchecks four things:mermaidblock starts with a known diagram type;It was proven red on an extra
{and onparticipant Actor. Every block also parses withmermaid@11's ownmermaid.parse().Verification (local)
Pest: 713 passed. Pint: clean.