docs.rocketpool.net

Rocket Pool Documentation Hub - Features Guides, FAQs, API Reference and more. It is written in Rspress.

We welcome all contributions! Please refer to our contribution guidelines.

Using the nix flake

curl -L https://nixos.org/nix/install | sh && mkdir -p ~/.config/nix && echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf

Then start the environment

nix develop

Your environment should be setup & the server should be started so you can make changes easily.

See the Justfile for available commands.

If you want to test this locally, follow the next few steps:

Clone this repo eg: git clone git@github.com:rocket-pool/docs.rocketpool.net.git
Move into the directory: cd docs.rocketpool.net
Install dependencies using: bun install
Run the dev server which will create the site and update automatically when you make changes: bun run dev
Go to http://localhost:3000/ in your browser to view the site.
Ensure that bun run build doesn't have any errors or dead links before creating a pull request

To add new pages and have them appear in the side menu, add the links to the sidebar property in the rspress.config.ts file for them to appear.