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

Add overview.drawio.svg #1725

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/drawio/overview.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions src/drawio/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# About these files

## `*.drawio`

`*.drawio` contains a diagram created by diagrams.net draw.io, an open-source
diagramming program. It stores the content of the diagram, which may include
text, shapes, icons, and images, along with formatting information.[^1]

They are easy to use and their size is affordable.

## `*.drawio.svg`

A `*.drawio.svg` is actually a `svg`(Scalable vector graphics) file but can be
edited with drawio utils, like extension on VSCode or online
website(https://www.drawio.com/)

By using `*.drawio.svg` rather than `*.drawio`, we can view the diagram on
GitHub.
The SVG file is editable on draw.io and can be embedded on Github.[^2]

[^1]: https://fileinfo.com/extension/drawio
[^2]: https://github.com/rust-lang/rustc-dev-guide/pull/1725#issuecomment-1627922452