mirror of
https://github.com/waku-org/js.waku.guide.git
synced 2025-02-23 20:28:19 +00:00
25 lines
902 B
Markdown
25 lines
902 B
Markdown
# Description
|
|
|
|
This repository is the source for https://docs.dappconnect.dev/.
|
|
|
|
It is built using [mdBook](https://rust-lang.github.io/mdBook/).
|
|
|
|
# Development
|
|
|
|
You will need to [install mdBook](https://github.com/rust-lang/mdBook#installation).
|
|
|
|
To start a server that also builds the page use:
|
|
```
|
|
mdbook serve
|
|
```
|
|
Will expose the built page under http://localhost:3000/.
|
|
|
|
# Continuous Integration
|
|
|
|
Two branches are built by [our Jenkins instance](https://ci.status.im/):
|
|
|
|
* `master` is deployed to https://docs.dappconnect.dev/ by [CI](https://ci.status.im/job/website/job/docs.dappconnect.dev/)
|
|
* `develop` is deployed to https://dev-docs.dappconnect.dev/ by [CI](https://ci.status.im/job/website/job/dev-docs.dappconnect.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.
|