Development Environment

This setup assumes you have Yarn, Volta and pre-commit installed.

If you prefer not to use Volta, make sure you're using Node 20.

First, open a terminal and clone the sentry-docs repo:

# Clone the docs repo
git clone git@github.com:getsentry/sentry-docs.git

Next, navigate into the cloned repo and run the following to install dependencies:

# Install or update application dependencies
make

Now, run the development webserver (depending on the docs you want to run):

# Start dev server for user docs
yarn dev

# Start dev server for developer docs
yarn dev:developer-docs

You will now be able to access docs via http://localhost:3000.

Linting

A few linters are available. Run yarn lint to apply them all.

Some lints can be auto-fixed with eslint

yarn lint:eslint:fix

Additionally we use prettier to format our code and markdown. Run prettier if you get linting errors in CI:

yarn lint:prettier:fix

Running typos locally

We use typos to check for spelling errors.

Option 1: Via pre-commit

make develop  # Sets up pre-commit hooks
pre-commit run typos --all-files

Option 2: Direct command

First, install typos:

• macOS/Linux: brew install typos-cli
• Cross-platform: cargo install typos-cli (requires Rust)
• Or download from GitHub releases

Then run:

yarn lint:typos