2021-09-29 11:29:34 +00:00
# Description
2022-01-10 14:51:42 +00:00
This repository is the source for https://docs.wakuconnect.dev/.
2021-09-29 11:29:34 +00:00
2021-12-09 14:27:58 +00:00
It is built using [Hugo ](https://gohugo.io/ ) static site generator.
2021-09-29 11:29:34 +00:00
# Development
2021-12-09 14:27:58 +00:00
You will need to [install Hugo ](https://gohugo.io/getting-started/installing ) and pull submodules:
```sh
git submodule update --init
2021-09-29 11:29:34 +00:00
```
2021-12-09 14:27:58 +00:00
To start a server that also builds the page use:
```sh
hugo server
2021-09-29 11:29:34 +00:00
```
2021-12-09 14:27:58 +00:00
Will expose the built page under http://localhost:1313/.
2021-09-29 11:29:34 +00:00
# Continuous Integration
2021-09-29 11:35:01 +00:00
Two branches are built by [our Jenkins instance ](https://ci.status.im/ ):
2022-01-10 14:51:42 +00:00
* `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/ )
2021-09-29 11:35:01 +00:00
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.
