Development Environment
This setup assumes you have Volta and pre-commit installed.
If you prefer not to use Volta, make sure you're using Node 18.
First, open a terminal and clone the sentry-docs
repo:
Copied
# 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:
Copied
# Install or update application dependencies
make
Now, run the development webserver:
Copied
yarn dev
You will now be able to access docs via http://localhost:3000.
A few linters are available. Run yarn lint
to apply them all.
Some lints can be autofixed with eslint
Copied
yarn lint:eslint:fix
Additionally we use prettier to format our code and markdown. Run prettier if you get linting errors in CI:
Copied
yarn lint:prettier:fix
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").