BuilderNet Docs & Blog

This repo contains docs and blog for https://buildernet.org

Getting started

Start the dev environment with Docker:

make docker-start

Now you can open the website on http://localhost:3000

See also the Makefile for more commands.

Note: you should really use Docker for these kinds of things, because yarn will install a ton of dependencies that all have full access to your system and can run arbitrary code on your machine during and after installation. Docker provides at least a somewhat isolated environment for this. But if you really want to live dangerously, you can also run npm install and npm start.

---

To start a new blog entry:

• Create a new file in /blog with the format YYYY-MM-DD-title.md
• See also
  • https://docusaurus.io/docs/blog for more options
  • Guide in the flashbots-writings repo
• Make sure you have a good social preview image and description. Test it with https://www.opengraph.xyz!

---

Notes

• When making a release, search for UPDATE_ON_RELEASE in the docs to see what needs to be updated
• The main index page is in /src/pages/index.js

---

Working with Docusaurus

make docker-shell

# Upgrade Docusaurus
yarn upgrade @docusaurus --latest

# Tag a version
npm run docusaurus docs:version:docs 1.2.1