Skip to main content

Create a Doc Starter

tip

The recommended way to add/edit content is locally, using your favorite text editor or IDE (e.g. VSCode, Cursor, VIM), optionally paired with an agentic coding assistant like Claude Code or Codex.

Minimum Requirements​

  1. Node.js version >=18 (Node 20 LTS recommended)

To see if you have node installed run the following:

node -v

If you don't have node, install it here or use your package installer of choice (e.g. Homebrew).

  1. Yarn version >=1.5 (Classic)

To see if you have yarn installed run the following:

yarn --version

If you don't have yarn installed, run the following:

npm install --global yarn

Alternatively, if you're on Node 16+, you can enable Corepack instead:

corepack enable
  1. Git CLI

To see if you have git installed run the following:

git --version

If you don't have git installed, install it here.

  1. An IDE or Code Editor

We recommend VSCode or Cursor if you don't already have an editor of choice. Command-line editors like VIM also work well.

  1. (Optional) Agentic Coding Assistant

An agentic coding assistant can speed up authoring and reviewing docs. Popular choices:

Now that your environment is ready, let's move on to setting up your development environment.