Skip to content

Commit

Permalink
chore: add small how to diagram section (#3804)
Browse files Browse the repository at this point in the history
Adding a small section on how to add diagrams to the yellow-paper.
  • Loading branch information
LHerskind committed Jan 3, 2024
1 parent 3030cc8 commit df581f0
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions yellow-paper/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,70 @@ The details should be sufficient for some other engineering team to implement th

Some of the info we need to populate this document might have already been written in the top-level `docs/` dir of the monorepo. But the target audience is different. Reduce verbose prose. Remove monorepo code snippets (but note that simple pseudocode snippets to explain a protocol concept are fine). Don't describe components of the sandbox (that's an implementation detail and doesn't belong in this doc).

## Diagrams
To increase the probability of diagrams being up to date we encourage you to write them in `mermaid`. Mermaid is a markdown-like language for generating diagrams and is supported by Docusaurus, so it will be rendered automatically for you.
You simply create a codeblock specifying the language as `mermaid` and write your diagram in the codeblock. For example:
```txt
```mermaid
graph LR
A --> B
B --> C
C --> A
```

```mermaid
graph LR
A --> B
B --> C
C --> A
```
Mermaid supports multiple types of diagrams, so finding one that suits your needs should be possible. Consult their [documentation](https://mermaid.js.org/intro/getting-started.html) or try out their [live editor](https://mermaid.live/) to see if they've got what you need.

When writing class diagrams, we recommend using the `classDiagram` type and composition arrows `*--` to represent extensions. Also for the sake of readability, add all the components in the class itself, including composite types. For example:

```txt
```mermaid
classDiagram
class A{
foo: Bar
}
class B{
hip: Hap
zap: Zip
}
class C{
a: A
b: B
flip: Flap
}
C *-- A: a
C *-- B: b
```

```mermaid
classDiagram
class A{
foo: Bar
}
class B{
hip: Hap
zap: Zip
}
class C{
a: A
b: B
flip: Flap
}
C *-- A: a
C *-- B: b
```

### Mermaid doesn't cover my case, what should I do?
If mermaid doesn't cover your case, please add both the rendered image and the source code to the documentation. Most of the tools for diagramming can export a non-rendered representation that can then be updated by other people. Please name it such that it is clear what tool was used.

This should allow us to keep the diagrams up to date, by allowing others to update them.


## For each protocol feature

Describe the requirements.
Expand Down

0 comments on commit df581f0

Please sign in to comment.