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.

Sign up for GitHub

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

Jump to bottom

[ENHANCEMENT] nicer doc diagrams #323

Open
mrchrisadams opened this issue Oct 27, 2022 · 0 comments
Open

[ENHANCEMENT] nicer doc diagrams #323

mrchrisadams opened this issue Oct 27, 2022 · 0 comments
Labels
Design / UX documentation Improvements or additions to documentation enhancement good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mrchrisadams
Copy link
Member

Is your feature request related to a problem? Please describe.

We use mermaidjs for our system diagrams now. They're a bit dull though, and mermaidjs has some option for more aethetically pleasing options using themes.

Describe the solution you'd like

We see how to implement themes and see if it's worth the investment of time to do so.

Describe alternatives you've considered

We looked at plantUML and other tools. Mermaidjs works in a browser, and as a result is lightweight enough incorporate in docs without much trouble.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Design / UX documentation Improvements or additions to documentation enhancement good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mrchrisadams