https://github.com/pooltogether/v4-docs

PoolTogether V4 Documentation
https://github.com/pooltogether/v4-docs

defi docs ethereum pooltogether web3

Last synced: 4 days ago
JSON representation

PoolTogether V4 Documentation

• Host: GitHub
• URL: https://github.com/pooltogether/v4-docs
• Owner: pooltogether
• Created: 2021-09-15T05:30:47.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T15:19:17.000Z (2 months ago)
• Last Synced: 2024-09-17T19:14:27.559Z (2 months ago)
• Topics: defi, docs, ethereum, pooltogether, web3
• Language: JavaScript
• Homepage: https://v4-docs.pooltogether.com/
• Size: 9.72 MB
• Stars: 11
• Watchers: 3
• Forks: 23
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# PoolTogether Developer Docs

The documentation is built using [Docusaurus 2](https://v2.docusaurus.io/).

# Contributing

## Update Deployed Contracts

You'll find the deployed networks in `docs/deployments` which are generated using `./scripts/generateV5Deployments.js` and contract lists in the `data` folder.

To update a deployment list:

1. Update the corresponding contract json file in the `data` folder

2. Run the script with the deployment you want to generate, ex: `node script/generateV5Deployments.js optimism`

# Contributing to PoolTogether Developer Docs

Contributing to the docs site is a great way to get involved in the dev community and help other devs along the way! Check out our guidelines [here](./CONTRIBUTING.md).

# How to add a new page

Create a markdown file in its respective versioned docs, or versioned SDK, directory.

# How to add internal links

Relative or absolute paths work. End links with a trailing `/`

## Installation

```console

yarn install

```

## Local Development

```console

yarn start

```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Clear cache

```console

yarn docusaurus clear

```

## Build

```console

yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console

GIT_USER= USE_SSH=true yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.