Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

 ________   ______   _______    ______         _______    ______    ______    ______
/        | /      \ /       \  /      \       /       \  /      \  /      \  /      \
$$$$$$$$/ /$$$$$$  |$$$$$$$  |/$$$$$$  |      $$$$$$$  |/$$$$$$  |/$$$$$$  |/$$$$$$  |
    /$$/  $$ |  $$ |$$ |__$$ |$$ |__$$ |      $$ |  $$ |$$ |  $$ |$$ |  $$/ $$ \__$$/
   /$$/   $$ |  $$ |$$    $$< $$    $$ |      $$ |  $$ |$$ |  $$ |$$ |      $$      \
  /$$/    $$ |  $$ |$$$$$$$  |$$$$$$$$ |      $$ |  $$ |$$ |  $$ |$$ |   __  $$$$$$  |
 /$$/____ $$ \__$$ |$$ |  $$ |$$ |  $$ |      $$ |__$$ |$$ \__$$ |$$ \__/  |/  \__$$ |
/$$      |$$    $$/ $$ |  $$ |$$ |  $$ |      $$    $$/ $$    $$/ $$    $$/ $$    $$/
$$$$$$$$/  $$$$$$/  $$/   $$/ $$/   $$/       $$$$$$$/   $$$$$$/   $$$$$$/   $$$$$$/

Live Docs Website

The Zora Docs site contains documentation on Zora contracts, SDKs, and the Zora Network.

It is built on the vocs framework.

Development Setup

Before running the dev server, from the root of the monorepo:

pnpm run build:site

Then, from the docs directory, start the dev server:

pnpm run dev

Generating UML Diagrams

The documentation includes UML diagrams generated from PlantUML source files. To generate these diagrams:

  1. Ensure you have Docker installed and running (used for PlantUML generation)

  2. PlantUML source files are located in the docs/uml directory with .puml extension

  3. Generate the diagrams by running:

pnpm run generate-uml

This will:

  • Process all .puml files in the docs/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:

![Diagram Name](/uml/diagram-name.svg)