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 diagrams to pdf #621

Open
williamdemeo opened this issue Dec 3, 2024 · 1 comment · May be fixed by #639
Open

Add diagrams to pdf #621

williamdemeo opened this issue Dec 3, 2024 · 1 comment · May be fixed by #639
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@williamdemeo
Copy link
Contributor

williamdemeo commented Dec 3, 2024

We need high-level diagrams that illustrate the overall layout of the ledger and how it works as a state machine (and as a ledger).

The new diagrams should go in cardano-ledger.pdf (probably not in conway-ledger.pdf which is mainly for describing aspects of the ledger that are specific to Conway).

Probably we want to start off with something simple, like the tikz latex package. However, automating the generation of diagrams would enable us to make sure the diagrams are updated when changes to the ledger occur. This will make the formal spec easier to maintain and help ensure the diagrams are correct and not misleading readers.

For automation, we might try to use the diagrams language, since it is Haskell based so could probably be plugged right into our stack without too much effort. However, it may take a day or two to learn and figure out how to configure and integrate it.

@williamdemeo williamdemeo added the documentation Improvements or additions to documentation label Dec 3, 2024
@williamdemeo williamdemeo self-assigned this Dec 3, 2024
@williamdemeo
Copy link
Contributor Author

williamdemeo commented Dec 3, 2024

Existing Diagrams

(* = links to internal Slack message or content)

@williamdemeo williamdemeo linked a pull request Jan 8, 2025 that will close this issue
4 tasks
@williamdemeo williamdemeo linked a pull request Jan 8, 2025 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant