Skip to content

Commit

Permalink
docs: regenerate governance diagrams (#3927)
Browse files Browse the repository at this point in the history
* docs: regenerate governance diagrams

Following #3888, add a shell script to generate the diagrams.
Rename the files for better consistency.
Check in new .pngs, since the .pumls were recently updated.

* chore: add a final newline
  • Loading branch information
Chris-Hibbert authored Oct 4, 2021
1 parent 1461f97 commit 724d629
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 3 deletions.
Binary file modified packages/governance/docs/contractGovernance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/governance/docs/contractGovernance.puml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@startuml contract governance
@startuml contractGovernance

package "GovernedContract Vat" <<Rectangle>> {
Object ParamManager {
Expand Down
Binary file modified packages/governance/docs/coreArchitecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/governance/docs/coreArchitecture.puml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@startuml governance invitation linkages
@startuml coreArchitecture

package Legend <<Rectangle>> #EEEEEE {

Expand Down
Binary file removed packages/governance/docs/example.png
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/governance/docs/example.puml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@startuml governance example
@startuml governanceExample

package "Example with Vote Invitation" <<rectangle>> {
class ContractGovernor {
Expand Down
10 changes: 10 additions & 0 deletions packages/governance/docs/gen.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/sh

pumljar="${PLANTUML:-$HOME/plantuml/plantuml.jar}"
page="index.md"
java -jar "$pumljar" "./**/*.puml"
echo "# Governance Diagrams" > "$page"
for diag in $(find . -name "*.png" | sort); do
echo "## $diag\n" >> "$page"
echo "[![$diag]($diag)]($diag)\n" >> "$page"
done
Binary file added packages/governance/docs/governanceExample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions packages/governance/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Governance Diagrams
## ./contractGovernance.png

[![./contractGovernance.png](./contractGovernance.png)](./contractGovernance.png)

## ./coreArchitecture.png

[![./coreArchitecture.png](./coreArchitecture.png)](./coreArchitecture.png)

## ./governanceExample.png

[![./governanceExample.png](./governanceExample.png)](./governanceExample.png)

0 comments on commit 724d629

Please sign in to comment.