Rocket Pool Documentation Hub - Features Guides, FAQs, API Reference and more. It is written in Vitepress.
We welcome all contributions! Please refer to our contribution guidelines.
Bun can be installed via:
curl -fsSL https://bun.sh/install | bash
Just (rust based task runner) can be installed via:
brew/apt-get install just
See the Justfile for available commands.
If you want to test this locally, follow the next few steps:
git clone git@github.com:rocket-pool/docs.rocketpool.net.git
cd docs.rocketpool.net
bun install
or yarn install
yarn dev
or bun run dev
http://localhost:5173/
in your browser to view the site.bun run build
doesn't have any errors or dead links before creating a pull requestFiles under docs/.vitepress
include components, style and configs.
To add new pages and have them appear in the side menu, add the links to the sidebar
property in the docs/.vitepress/config.ts
file for them to appear.