Skip to content

Files

Latest commit

eb061bd · Feb 20, 2025

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 2, 2024
Sep 19, 2024
Feb 20, 2025
Dec 24, 2024
Dec 24, 2024
Jan 30, 2025
Dec 24, 2024
Sep 27, 2024
Dec 24, 2024
Jan 30, 2025
Jun 26, 2024
Jul 23, 2024
Sep 26, 2024
Jan 30, 2025
 ________   ______   _______    ______         _______    ______    ______    ______
/        | /      \ /       \  /      \       /       \  /      \  /      \  /      \
$$$$$$$$/ /$$$$$$  |$$$$$$$  |/$$$$$$  |      $$$$$$$  |/$$$$$$  |/$$$$$$  |/$$$$$$  |
    /$$/  $$ |  $$ |$$ |__$$ |$$ |__$$ |      $$ |  $$ |$$ |  $$ |$$ |  $$/ $$ \__$$/
   /$$/   $$ |  $$ |$$    $$< $$    $$ |      $$ |  $$ |$$ |  $$ |$$ |      $$      \
  /$$/    $$ |  $$ |$$$$$$$  |$$$$$$$$ |      $$ |  $$ |$$ |  $$ |$$ |   __  $$$$$$  |
 /$$/____ $$ \__$$ |$$ |  $$ |$$ |  $$ |      $$ |__$$ |$$ \__$$ |$$ \__/  |/  \__$$ |
/$$      |$$    $$/ $$ |  $$ |$$ |  $$ |      $$    $$/ $$    $$/ $$    $$/ $$    $$/
$$$$$$$$/  $$$$$$/  $$/   $$/ $$/   $$/       $$$$$$$/   $$$$$$/   $$$$$$/   $$$$$$/

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

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)