Skip to content

Commit 063ea23

Browse files
andyminaW-A-James
andauthored
docs(NODE-3363): added docs for proposed error hierarchy (#2862)
Co-authored-by: Warren James <[email protected]>
1 parent 526c73f commit 063ea23

14 files changed

+338
-0
lines changed

docs/charts/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Charts and mermaid code
2+
3+
The `mermaid` directory contains the [mermaid](https://mermaid-js.github.io/mermaid/#/) files which serve as the source code for the svg files included in the `../errors.md`
4+
5+
To generate these files, there is an included script, `build_images.sh` which builds images for all the mermaid files in the `mermaid` directory.
6+
7+
To use this script, the [mermaid cli](https://github.com/mermaid-js/mermaid-cli) must be installed and be accessible via your $PATH variable.

docs/charts/build_images.sh

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#! /bin/bash
2+
3+
echo "Building svgs..."
4+
cd mermaid
5+
for f in *.mmd
6+
do
7+
echo "Processing $f"
8+
outname="${f%%.*}"
9+
mmdc -i $f -o ../imgs/$outname.svg &
10+
done
11+
wait
12+
13+
echo "Done"

docs/charts/imgs/MongoAPIError.svg

+4
Loading

0 commit comments

Comments
 (0)