{"id":18437842,"url":"https://github.com/zilliqa/dev-portal","last_synced_at":"2026-02-19T09:19:06.353Z","repository":{"id":241101909,"uuid":"802830332","full_name":"Zilliqa/dev-portal","owner":"Zilliqa","description":"Documentation for Zilliqa developer","archived":false,"fork":false,"pushed_at":"2025-04-11T07:35:30.000Z","size":23901,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-14T13:14:31.290Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://dev.zilliqa.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-19T11:45:31.000Z","updated_at":"2025-04-08T16:54:41.000Z","dependencies_parsed_at":"2024-05-28T18:20:10.710Z","dependency_job_id":"f7e7334d-5bd3-4727-a466-c8625500c431","html_url":"https://github.com/Zilliqa/dev-portal","commit_stats":null,"previous_names":["zilliqa/dev-portal"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fdev-portal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fdev-portal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fdev-portal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fdev-portal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/dev-portal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886342,"owners_count":21177645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:23.478Z","updated_at":"2026-02-19T09:19:06.344Z","avatar_url":"https://github.com/Zilliqa.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Zilliqa/dev-portal)\n\n# Zilliqa developer documentation\n\nThis repository contains the Zilliqa developer documentation.\n\n- The `main` branch has CD at [https://stg-dev.zilliqa.com/](https://stg-dev.zilliqa.com/)\n- Releases to go to [https://dev.zilliqa.com](https://dev.zilliqa.com/)\n\n## How it works\n\nThe developer portal is a `mkdocs` materials-themed site for Zilliqa 2.\n\nThe Zilliqa 2 site includes content created by the rust program in `docgen` - see below.\n\nIt is served in production by an nginx container, built by the `Dockerfile` and using the\nconfig file from `default.conf`.\n\nThe material theme is fairly heavily customised with overrides.\n\nIf you want to build the docs from a checked out version of zq2, set\n`USE_ZQ2_FROM` to the location of your zq2 directory and `NO_CHECKOUT`\nto skip checkouts.\n\n## Docgen\n\nThe `docgen` program:\n\n- Reads the `zq2_spec.yaml` file in this directory.\n- Clones Zilliqa 2 into `cache/zq2`\n- Runs the `docgen` program in Zilliqa 2 to generate API documentation.\n- Repeats the process for all the versions of Zilliqa 2 it is to document.\n- Generates an `mkdocs.yaml`\n\n`mkdocs.yaml` for zq2 is generated from:\n\n- `zq2/mkdocs.in.yaml`, which inherits from\n- `zq2/parent.yaml`\n\n## Developing\n\nDevelopment is controlled by the `Makefile` in this directory.\n\nYou will need `mkdocs`. Make sure you're in a venv (because `mkdocs`\ndoesn't seem to like installing outside one):\n\n```sh\npython -m venv ~/mydir\nsource ~/mydir/bin/activate\n```\n\nAnd then:\n\n```sh\npip3 install -r requirements.txt\n```\n\nYou will also need enough local tooling installed to build ZQ2; this\nstarts with [installing\nRust](https://www.rust-lang.org/tools/install), but there are other\ntools - including cmake and protobuf required. Check the [zq2\nrepository](https://github.com/zilliqa/zq2) for details.\n\nNow,\n\n- `make dev2` will do the same with the ZQ2 docs.\n\nYou can set `SERVEROPTS` to pass option (usually `-a\n\u003clisten_address\u003e:\u003cport\u003e`) to `mkdocs serve`.\n\nIf you want to check containerised builds, `make run-image` will do\nthat for you and run it on port 8080.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fdev-portal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fdev-portal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fdev-portal/lists"}