https://github.com/renproject/ren-client-docs
Docs for interacting with Ren and RenVM
https://github.com/renproject/ren-client-docs
Last synced: 9 months ago
JSON representation
Docs for interacting with Ren and RenVM
- Host: GitHub
- URL: https://github.com/renproject/ren-client-docs
- Owner: renproject
- Created: 2021-04-06T01:06:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-02T04:27:54.000Z (over 3 years ago)
- Last Synced: 2025-05-14T02:52:02.844Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://renproject.github.io/ren-client-docs
- Size: 73.7 MB
- Stars: 1
- Watchers: 9
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/).
## Local Development
To start a development server:
```shell
yarn
npx docusaurus graphql-to-doc
yarn start
```
To build:
```shell
yarn build
```
To deploy:
```shell
yarn deploy
```
## Adding deployments for a new chain or asset
1. Update the `gateway-sol` submodule:
```shell
git submodule update --init --recursive
```
2. Add any new chains to the table in deployments.mdx and add its explorers in `RenderGatewaySolConfig.tsx`. For new assets, add the icons to contracts/icons and then list the asset in `RenderGatewaySolConfig.tsx`
# Updating auto-generated docs
## Contract Reference Types
The contract types are manually moved built and moved in from the contract repos. Assuming `gateway-sol`, `darknode-sol` and `ren-client-docs` are all in the same directory, then the following steps will update these docs:
```shell
cd ../gateway-sol
yarn docs && rm -rf ../docs/ren-client-docs/contracts/gateway-sol && mv docs ../docs/ren-client-docs/contracts/gateway-sol
cd ../darknode-sol
yarn docs && rm -rf ../docs/ren-client-docs/contracts/darknode-sol && mv docs ../docs/ren-client-docs/contracts/darknode-sol
cd ../ren-client-docs
```
If contracts have been moved around or renamed or added/deleted, then the sidebar in `sidebarsContracts.js` should be updated.
## JSON-RPC
The JSON-RPC docs are automatically generated from the OpenAPI spec in `./tools/json-rpc.json`.