31 lines
961 B
Markdown
31 lines
961 B
Markdown
# Description
|
|
|
|
This repository is the source for https://docs.wakuconnect.dev/.
|
|
|
|
It is built using [Hugo](https://gohugo.io/) static site generator.
|
|
|
|
# Development
|
|
|
|
You will need to [install Hugo](https://gohugo.io/getting-started/installing) and pull submodules:
|
|
|
|
```sh
|
|
git submodule update --init
|
|
```
|
|
|
|
To start a server that also builds the page use:
|
|
|
|
```sh
|
|
hugo server
|
|
```
|
|
|
|
Will expose the built page under http://localhost:1313/.
|
|
|
|
# Continuous Integration
|
|
|
|
Two branches are built by [our Jenkins instance](https://ci.status.im/):
|
|
|
|
- `master` is deployed to https://docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/docs.wakuconnect.dev/)
|
|
- `develop` is deployed to https://dev-docs.wakuconnect.dev/ by [CI](https://ci.status.im/job/website/job/dev-docs.wakuconnect.dev/)
|
|
|
|
PRs should be made for `develop` branch and `master` should be [rebased](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on `develop` once changes are verified.
|