Skip to content

Add more diagrams to the component docs #253

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

Open
kate-goldenring opened this issue May 7, 2025 · 2 comments
Open

Add more diagrams to the component docs #253

kate-goldenring opened this issue May 7, 2025 · 2 comments

Comments

@kate-goldenring
Copy link
Collaborator

Can make the book more consumable

More graphics/images: Images and graphics drive our point home and help with retention. We should consider reinforcing concepts graphically with ALT text + captions. We must consider the graphic/imaging software we intend to use with our current SSG since not all frameworks integrate well with every SSG.

There is a way to make diagrams work in both light and dark mode -- we should use this magical technique if we can

ref #101 (comment)

@vados-cosmonic
Copy link
Contributor

vados-cosmonic commented May 7, 2025

@mkatychev had a good point on this -- we can use a mermaid plugin for mdbook here (and it will handle my concerns about light/dark mode)

@mkatychev
Copy link
Contributor

https://github.com/badboy/mdbook-mermaid is a preprocessor we could look into to have it show up in the mdbook output as well

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

No branches or pull requests

3 participants