Re: [whatwg/storage] Editorial: Add a diagram for storage model (PR #152)

@annevk commented on this pull request.



> @@ -21,3 +21,7 @@ local: storage.bs
 deploy: storage.bs
  curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh
  bash ./deploy.sh
+
+build-diagram: assets/model-diagram.mmd
+ mmdc -i assets/model-diagram.mmd -o assets/model-diagram.svg -c assets/mmdc.config.json
+ svgo -f assets -o assets/ --config assets/svgo.config.js

We cannot change the `Makefile` as it's generated from whatwg/spec-factory. A simple `npm` script might be preferable anyway?

>  <a>storage bottles</a>, one for each <a>storage endpoint</a>.
 
+<p><img src=assets/model-diagram.svg alt="Storage model diagram" aria-describedBy=model-description
+width=396 height=815>

Is this really preferable over `alt="Storage model diagram (described above)."` and no `aria-describedby` (lowercase please)?

Flipping the order and using "described below" might be even better as then the image serves as a kind of heading?

> @@ -0,0 +1,11 @@
+erDiagram
+
+%% This is the source file for `model-diagram.svg`.
+%% Prerequisites: `npm i -g @mermaid-js/mermaid-cli svgo`
+%% Build command: `make model-diagram`
+
+"User agent" ||--|| "Storage shed" : "holds (local)"
+"Browsing session" ||--|| "Storage shed" : "holds (session)"
+"Storage shed" ||--o{ "Storage shelf" : "for each storage key"
+"Storage shelf" ||--|| "Storage bucket" : "holds (default)"
+"Storage bucket" ||--|{ "Storage bottle" : "for each storage endpoint"

Shall we lowercase all these terms? I'm not entirely sure, but it looks a little off to me at the moment.

-- 
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/storage/pull/152#pullrequestreview-1189654555
You are receiving this because you are subscribed to this thread.

Message ID: <whatwg/storage/pull/152/review/1189654555@github.com>