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

enable mermaid diagrams #10

Closed
clux opened this issue Mar 2, 2022 · 0 comments · Fixed by #9
Closed

enable mermaid diagrams #10

clux opened this issue Mar 2, 2022 · 0 comments · Fixed by #9
Assignees

Comments

@clux
Copy link
Member

clux commented Mar 2, 2022

See https://squidfunk.github.io/mkdocs-material/reference/diagrams/ - now free to use in mkdocs-material 8.2

Probably good to use some flow diagrams when explaining reconciler flow in #5

@clux clux changed the title enable mermaid diagrams and add some to architecture.md enable mermaid diagrams Mar 2, 2022
@clux clux self-assigned this Mar 2, 2022
clux added a commit that referenced this issue Mar 2, 2022
- adds first mermaid diagram - closes #10
- adds tables
- adds a file for common links
- adds a file for common abbreviations

and also starts writing the doc for the common objects

Signed-off-by: clux <[email protected]>
@clux clux linked a pull request Mar 2, 2022 that will close this issue
@clux clux closed this as completed in #9 Mar 7, 2022
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 a pull request may close this issue.

1 participant