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

Replace all graphviz diagrams with raster images #36

Closed
lparisc opened this issue Sep 12, 2022 · 1 comment · Fixed by eosnetworkfoundation/docs#19
Closed

Replace all graphviz diagrams with raster images #36

lparisc opened this issue Sep 12, 2022 · 1 comment · Fixed by eosnetworkfoundation/docs#19
Assignees
Labels

Comments

@lparisc
Copy link
Contributor

lparisc commented Sep 12, 2022

The current docsgen tool doesn't support Graphviz diagrams. The long term solution is to port all Graphviz diagrams to Mermaid, which is supported by our docsgen tool via a workaround. Official support might be added later.

In the meantime, we need to replace all Graphviz diagrams with their corresponding raster image. This affects mainly the Protocol Guides, although there are other docs that use Graphviz diagrams, including system diagrams. Replace those.

@lparisc lparisc added the documentation Improvements or additions to documentation label Sep 12, 2022
@lparisc lparisc self-assigned this Sep 12, 2022
@lparisc
Copy link
Contributor Author

lparisc commented Sep 16, 2022

Solution steps:

  1. Obtain original graphviz/dot script.
  2. Display in a graphviz/dot viewer (script contains one)
  3. Export to .svg or .pgn raster image.
  4. Replace script with raster image reference.

@lparisc lparisc transferred this issue from eosnetworkfoundation/docs Sep 22, 2022
@VEG-Ginna VEG-Ginna added Content and removed documentation Improvements or additions to documentation labels Sep 22, 2022
@lparisc lparisc moved this from In Progress to Review in Developer Relations Sep 27, 2022
Repository owner moved this from Review to Done in Developer Relations Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants