This documentation page is a stub and should be expanded over time.
Generally, format code with cargo fmt
.
The miningpool-observer-daemon
and miningpool-observer-web
crate share code via the miningpool_observer_shared
crate.
The icons and logos are created with Inkscape. Generally, the SVG source files should be saved as Inkscape-SVGs in the artwork directory. The Inkscape SVGs used as static assets should be saved as Plain-SVGs or Optimized-SVGs.
The OpenGraph SVG templates located in (artwork/ogimage_templates)[../artwork/ogimage_templates] should be saved as both Inkscape-SVGs and Plain-SVGs.
These should be optimized by running the optimize-svgs-with-scour.sh
script.
This requires scour to be installed.