________ ______ _______ ______ _______ ______ ______ ______
/ | / \ / \ / \ / \ / \ / \ / \
$$$$$$$$/ /$$$$$$ |$$$$$$$ |/$$$$$$ | $$$$$$$ |/$$$$$$ |/$$$$$$ |/$$$$$$ |
/$$/ $$ | $$ |$$ |__$$ |$$ |__$$ | $$ | $$ |$$ | $$ |$$ | $$/ $$ \__$$/
/$$/ $$ | $$ |$$ $$< $$ $$ | $$ | $$ |$$ | $$ |$$ | $$ \
/$$/ $$ | $$ |$$$$$$$ |$$$$$$$$ | $$ | $$ |$$ | $$ |$$ | __ $$$$$$ |
/$$/____ $$ \__$$ |$$ | $$ |$$ | $$ | $$ |__$$ |$$ \__$$ |$$ \__/ |/ \__$$ |
/$$ |$$ $$/ $$ | $$ |$$ | $$ | $$ $$/ $$ $$/ $$ $$/ $$ $$/
$$$$$$$$/ $$$$$$/ $$/ $$/ $$/ $$/ $$$$$$$/ $$$$$$/ $$$$$$/ $$$$$$/
The Zora Docs site contains documentation on Zora contracts, SDKs, and the Zora Network.
It is built on the vocs framework.
Before running the dev server, from the root of the monorepo:
pnpm run build
Then, from the docs
directory, start the dev server:
pnpm run dev
The documentation includes UML diagrams generated from PlantUML source files. To generate these diagrams:
-
Ensure you have Docker installed and running (used for PlantUML generation)
-
PlantUML source files are located in the
docs/uml
directory with.puml
extension -
Generate the diagrams by running:
pnpm run generate-uml
This will:
- Process all
.puml
files in thedocs/uml
directory - Generate SVG diagrams in
public/uml
- Use Docker to handle loading of the PlantUML server
The generated diagrams can be referenced in documentation using:
