Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add control flow diagrams #2244

Merged
merged 1 commit into from Nov 1, 2022
Merged

docs: Add control flow diagrams #2244

merged 1 commit into from Nov 1, 2022

Conversation

ntucker
Copy link
Collaborator

@ntucker ntucker commented Nov 1, 2022

Github and docuarus added support for mermaid. These diagrams allow svg demonstrations. They aren't super pretty but make it easy to get the point across. Lifecycle explanations was originally brought up by @sweetro as one of the most useful docs to add that was missing.

Entity

entity-lifecycle

RestEndpoint

fetch-lifecycle

Endpoint

endpoint-lifecycle

Schema updates

Also included updates to schema pages

@codecov-commenter
Copy link

codecov-commenter commented Nov 1, 2022

Codecov Report

Merging #2244 (c650fca) into master (fceab55) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2244   +/-   ##
=======================================
  Coverage   98.54%   98.54%           
=======================================
  Files         114      114           
  Lines        1860     1860           
  Branches      273      273           
=======================================
  Hits         1833     1833           
  Misses         10       10           
  Partials       17       17           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ntucker ntucker requested a review from notwillk November 1, 2022 15:52
@ntucker ntucker force-pushed the docs/controlflow branch 8 times, most recently from c650fca to f4aa56b Compare November 1, 2022 17:14
Copy link
Collaborator

@notwillk notwillk left a comment

Choose a reason for hiding this comment

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

Mermaid FTW

@ntucker ntucker merged commit e36a01e into master Nov 1, 2022
@ntucker ntucker deleted the docs/controlflow branch November 1, 2022 17:29
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.

None yet

3 participants