https://github.com/zilliqa/dev-portal
Documentation for Zilliqa developer
https://github.com/zilliqa/dev-portal
Last synced: 4 months ago
JSON representation
Documentation for Zilliqa developer
- Host: GitHub
- URL: https://github.com/zilliqa/dev-portal
- Owner: Zilliqa
- Created: 2024-05-19T11:45:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T07:35:30.000Z (about 1 year ago)
- Last Synced: 2025-04-14T13:14:31.290Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://dev.zilliqa.com
- Size: 22.8 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://deepwiki.com/Zilliqa/dev-portal)
# Zilliqa developer documentation
This repository contains the Zilliqa developer documentation.
- The `main` branch has CD at [https://stg-dev.zilliqa.com/](https://stg-dev.zilliqa.com/)
- Releases to go to [https://dev.zilliqa.com](https://dev.zilliqa.com/)
## How it works
The developer portal is a `mkdocs` materials-themed site for Zilliqa 2.
The Zilliqa 2 site includes content created by the rust program in `docgen` - see below.
It is served in production by an nginx container, built by the `Dockerfile` and using the
config file from `default.conf`.
The material theme is fairly heavily customised with overrides.
If you want to build the docs from a checked out version of zq2, set
`USE_ZQ2_FROM` to the location of your zq2 directory and `NO_CHECKOUT`
to skip checkouts.
## Docgen
The `docgen` program:
- Reads the `zq2_spec.yaml` file in this directory.
- Clones Zilliqa 2 into `cache/zq2`
- Runs the `docgen` program in Zilliqa 2 to generate API documentation.
- Repeats the process for all the versions of Zilliqa 2 it is to document.
- Generates an `mkdocs.yaml`
`mkdocs.yaml` for zq2 is generated from:
- `zq2/mkdocs.in.yaml`, which inherits from
- `zq2/parent.yaml`
## Developing
Development is controlled by the `Makefile` in this directory.
You will need `mkdocs`. Make sure you're in a venv (because `mkdocs`
doesn't seem to like installing outside one):
```sh
python -m venv ~/mydir
source ~/mydir/bin/activate
```
And then:
```sh
pip3 install -r requirements.txt
```
You will also need enough local tooling installed to build ZQ2; this
starts with [installing
Rust](https://www.rust-lang.org/tools/install), but there are other
tools - including cmake and protobuf required. Check the [zq2
repository](https://github.com/zilliqa/zq2) for details.
Now,
- `make dev2` will do the same with the ZQ2 docs.
You can set `SERVEROPTS` to pass option (usually `-a
:`) to `mkdocs serve`.
If you want to check containerised builds, `make run-image` will do
that for you and run it on port 8080.