LICENSE Documentation

1. Project Overview & Quickstart (OpenZeppelin/LICENSE) Copy Chapter

LICENSE

Open-source repository OpenZeppelin/LICENSE

Repository Details Copy Section

• Repository: OpenZeppelin/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (OpenZeppelin/docs) Copy Chapter

OpenZeppelin Docs

Welcome to the OpenZeppelin Docs repo! Before opening an issue or creating a PR please consult our contribution guide as well as the OpenZeppelin Documentation Standards

Development Copy Chapter

This is a Next.js application generated with Fumadocs.

To start local development follow the steps below

1. Make sure pnpm is installed

pnpm --version

2. Clone the repo and install dependencies

git clone https://github.com/OpenZeppelin/docs
cd docs
pnpm install

3. Run the dev server to see a live preview and have your changes reflected at http://localhost:3000

pnpm dev

4. Run build and lint

pnpm run build
pnpm run check

Project Overview Copy Chapter

This documentation site is built with:

• Next.js - React framework for the application
• Fumadocs - Documentation framework with MDX support
• TypeScript - Type-safe development

Directory Structure Copy Section

docs/
├── content/           # MDX documentation files organized by product
├── src/
│   ├── app/          # Next.js app directory (routes and layouts)
│   ├── components/   # React components
│   ├── navigation/   # Navigation configuration files
│   └── lib/          # Utility libraries
├── public/           # Static assets
└── scripts/          # Build and utility scripts

For detailed information about the codebase structure, navigation system, and component architecture, see CONTRIBUTING.md

API Reference Generation Copy Chapter

API reference pages are auto-generated from source contract repositories and placed in the content/ directory. The generation is handled by scripts/generate-api-docs.js, which supports two modes depending on the source repo's language.

Solidity Repos Copy Section

For Solidity repos using solidity-docgen, the script injects canonical MDX templates from this repo's docgen/templates-md/ into the cloned source repo before running docgen. Source repos do not need MDX templates committed.

The script automatically:

• Copies docgen/templates-md/ and docgen/config-md.js into the source repo
• Sets API_DOCS_PATH based on the output directory
• Updates the GitHub source link and import path for the source repo
• Patches hardhat.config.js to use the MDX config
• Runs npm run prepare-docs to generate MDX files
• Copies the output to the specified content/ directory

Run locally:

# openzeppelin-contracts
node scripts/generate-api-docs.js \
  --repo https://github.com/OpenZeppelin/openzeppelin-contracts.git \
  --branch v5.6.1 \
  --api-output content/contracts/5.x/api

# community-contracts
node scripts/generate-api-docs.js \
  --repo https://github.com/OpenZeppelin/openzeppelin-community-contracts.git \
  --branch master \
  --api-output content/community-contracts/api

# confidential-contracts
node scripts/generate-api-docs.js \
  --repo https://github.com/OpenZeppelin/openzeppelin-confidential-contracts.git \
  --branch v0.4.0 \
  --api-output content/confidential-contracts/api

Non-Solidity Repos Copy Section

For repos using other languages (Cairo, Move, Rust, etc.) that generate MDX through their own tooling, use the --pre-generated flag to skip docgen and copy pre-built MDX files directly:

node scripts/generate-api-docs.js \
  --repo https://github.com/OpenZeppelin/cairo-contracts.git \
  --branch v3.0.0 \
  --api-output content/contracts-cairo/3.x/api \
  --pre-generated docs/api

Canonical Templates Copy Section

The MDX templates that control API reference output live in docgen/templates-md/:

• helpers.js - Reference resolution, link generation, callout processing, natspec handling
• contract.hbs - Contract page layout (heading, GitHub link, import, function/event/error cards)
• page.hbs - Page wrapper with frontmatter
• properties.js - Solidity AST property helpers (anchors, inheritance, function lists)
• config-md.js - Solidity docgen configuration

Changes to these templates affect all source repos on the next generation run.

Automated Workflow Copy Section

The generation runs automatically via GitHub Actions:

1. Source repo pushes a release tag (e.g., v5.6.1) or commits to a tracked branch
2. Source trigger workflow (.github/workflows/docs.yml in the source repo) calls this repo's receiver workflow via gh workflow run
3. Receiver workflow (.github/workflows/generate-api-docs-{name}.yml) runs generate-api-docs.js, validates links, and creates a PR

Receiver workflows in this repo:

• generate-api-docs-contracts.yml - versioned paths (content/contracts/{major}.x/api)
• generate-api-docs-community-contracts.yml - non-versioned (content/community-contracts/api)
• generate-api-docs-confidential-contracts.yml - non-versioned (content/confidential-contracts/api)

Source repos need a DOCS_REPO_TOKEN secret (GitHub PAT with repo + workflow scopes) for the trigger workflow to call this repo.

Versioning Copy Section

• Major version changes (e.g., 4.x to 5.x) create a new versioned directory
• Minor and patch releases within a major version regenerate the same directory
• Non-versioned repos (community-contracts, confidential-contracts) use a flat api/ path

Content Management Copy Chapter

Adding New Content Copy Section

1. Create .mdx files in appropriate content/ subdirectories
2. Use frontmatter for metadata (title, description, etc.)
3. Follow existing directory structure for consistency
4. Update navigation if adding new product categories

Updating `llms.txt` Copy Section

The public/llms.txt file is generated from the navigation tree and MDX frontmatter. Run the generator whenever you add, remove, rename, or reorder navigation items, or when you update page descriptions that should appear in llms.txt.

pnpm run generate:llms-txt

Versioning Copy Section

• Version-specific content in numbered subdirectories (e.g., contracts/4.x/)
• Latest content at root level of each product directory
• Automatic version detection and routing

Learn More Copy Chapter

To learn more about the technologies used:

• Next.js Documentation - React framework features and API
• Fumadocs - Documentation framework
• MDX - Markdown with JSX components