https://github.com/openzeppelin/docs.openzeppelin.com
Source for the OpenZeppelin documentation site
https://github.com/openzeppelin/docs.openzeppelin.com
Last synced: 10 months ago
JSON representation
Source for the OpenZeppelin documentation site
- Host: GitHub
- URL: https://github.com/openzeppelin/docs.openzeppelin.com
- Owner: OpenZeppelin
- Created: 2019-06-25T21:25:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-18T20:04:38.000Z (10 months ago)
- Last Synced: 2025-06-18T20:32:47.820Z (10 months ago)
- Language: SCSS
- Homepage: https://docs.openzeppelin.com
- Size: 4.49 MB
- Stars: 46
- Watchers: 12
- Forks: 93
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[Deployment logs](https://app.netlify.com/sites/openzeppelin-docs/deploys)
### Adding a new repo
Edit the [`playbook.yml`](playbook.yml) file by adding the new repository under
"sources", with the branch or branches that should be deployed, and the path
where the `antora.yml` file is found.
For the site to rebuild when there is an update, you need to add a webhook in
the repo. In the Netlify panel, go to Site Settings > Build & deploy > Build
hooks, and copy the hook URL. In the repo that is being added, go to Settings >
Webhooks, and add a webhook using this URL and the default settings.
To show it in the sidebar, add the `name` from the repo's `antora.yml` in
[`navigation.hbs`](./ui/theme/partials/navigation.hbs#L17-L25), and add an svg icon
inside the [`icons folder`](./ui/theme/images/icons) matching the name.
Finally, add an entry for it inside the [`model.yml`](./ui/preview/model.yml) file, for UI development purposes.
### Pre-processing
The contents of each repository under `sources` in `playbook.yml` are used as-is
with no pre-processing. If the repository requires a pre-processing step, it must
be done in the CI of that repository and the results pushed to a branch (e.g., `docs`).
This branch should then be specified as the source in `playbook.yml` instead of the
source branch (e.g., `HEAD`).
An example of a CI Github Action that pre-processes the `master` branch and
pushes the result to the `docs-v*` branch can be found in the OpenZeppelin
Contracts [docs workflow](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/.github/workflows/docs.yml).
This workflow creates an automated API reference for the Contracts library.