Skip to content

task: add detailed mermaid flow diagram to the readme #64

Closed
@GrantBirki

Description

@GrantBirki

This issue tracks work to add a detailed mermaid flow diagram to the main README. The core flow that should be documented can be found in lib/hooks/app/api.rb. It should account for handlers, auth plugins, lifecycle plugins, etc. More context around how the whole service works can be found in the docs/* directory. Much of the source code should be inspected when designing a detailed request flow diagram and it should be mermaid style.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions