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

Use excalidraw for our manually-created diagrams #667

Open
choldgraf opened this issue Dec 17, 2022 · 0 comments
Open

Use excalidraw for our manually-created diagrams #667

choldgraf opened this issue Dec 17, 2022 · 0 comments

Comments

@choldgraf
Copy link
Collaborator

Currently we have diagrams embedded as PNGs that are created by various kinds of diagram software. However, PNGs are beefy and not great for git, and they are also a little bit hard to make edits to unless you've got access to the original software used to create the PNG.

In recent years, Excalidraw has become a popular way for maintainers to create diagrams that is a bit more git-friendly, that looks good, and is easy to edit / re-edit by anybody.

In particular, you can export excalidraw to an SVG, this can include embedded excalidraw metadata so that somebody can re-load the SVG into Excalidraw and make edits as they wish. We could then propose changes via edits to an SVG, rather than a new binary PNG file.

Also of note is that excalidraw is open source and generally a pretty well-maintained project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants