Skip to main content
This page guides you through contributing to the Bazel documentation, from a one-line typo fix to adding a new page. For style guidance, see the Bazel docs style guide.

​
Bazel docs structure

The source of truth for Bazel documentation is bazelbuild/bazel, where docs live alongside the code. bazel-contrib/bazel-docs is the hosting and pipeline layer: it syncs content from bazelbuild/bazel, generates PR previews, and holds Mintlify configuration. Content changes always go to bazelbuild/bazel. Bazel docs use MDX format, Markdown with a YAML frontmatter block at the top. Every page must start with:

​
Prerequisites

Before you start, you need:

​
Make a minor change

For small isolated changes, such as a typo, broken link, phrasing tweaks, you can edit directly in the GitHub web UI without cloning anything.
  1. Find the file in bazelbuild/bazel/docs/ on GitHub.
  2. To edit the file, click the pencil icon in the top-right corner.
  3. Make your edit.
  4. Click Commit changes…, provide a commit message, and click Propose changes”.
  5. GitHub prompts you to open a pull request. Set the base branch to master and click Create pull request it.

​
Update existing content

Use this workflow for anything larger than a typo, such as rewording a section, correcting outdated information, or adding a paragraph to an existing page.

​
Set up locally

Fork bazelbuild/bazel on GitHub first, then clone the repo and add the upstream remote:

​
Make and preview your changes

Check out a new branch off of master.
Edit the file in docs/, for example, docs/concepts/labels.mdx. To preview locally, you need a local copy of bazel-contrib/bazel-docs:
Copy your changed file(s) into the local bazel-docs mirror to preview them:
Open http://localhost:3000 to render your changes.

​
Commit and open a PR

Add, commit, and push your changes:
Open a pull request on GitHub from your fork to bazelbuild/bazel master.

​
Add a new section to an existing page

Follow the same workflow as Update existing content. A few things to keep in mind: Add a heading anchor ID. Every heading should have an explicit {#id} so URLs to that section stay stable even if the heading text changes:
Use sentence case for headings. Write “Getting started” not “Getting Started”. Keep the heading hierarchy consistent. Pages use H2 (##) for top-level sections and H3 (###) for subsections. Don’t skip levels. Update the page if there’s a table of contents or “On this page” intro. Some pages have an introductory list of topics. Add your section there too.

​
Add a new page

  1. Create the MDX file in the appropriate docs/ subdirectory. Every file must start with frontmatter:
  2. Add your page to the sidebar navigation. This requires a separate change in bazel-contrib/bazel-docs. See Update the docs navigation for instructions. For an initial PR, you can skip this and ask a maintainer to help.
  3. Follow the same branch, commit, and PR steps as Update existing content.

​
MDX basics for doc contributors

MDX is mostly standard Markdown with a few differences.

​
Self-closing HTML tags

JSX requires void elements to be self-closing. Use <img ... /> and <br />, not <img ...> or <br>. Use root-relative paths for internal links. Don’t include the .mdx extension in the links:

​
Code blocks

Always specify a language for syntax highlighting:
Common languages used in Bazel docs: bash, python, starlark, json, posix-terminal.

​
Images

Place images in the images/ subdirectory alongside your MDX file and reference them with a root-relative path:
Use self-closing syntax: Markdown image syntax does not require the trailing />, but <img> tags must self-close when you use them directly:

​
Notes and callouts

Mintlify supports callout components. Use them for important warnings or tips:
For a full list of Mintlify formatting components (tabs, accordions, cards, and more), see the Mintlify text formatting docs.

​
What to expect after submitting

  • The Google CLA bot checks that you’ve signed the Contributor License Agreement. You only need to do this once.
  • CI runs a docs validation check.
  • A maintainer reviews your PR and might request edits. Response times vary.
  • Once approved, a maintainer merges your changes to master. They appear on the live site after the next sync.
If your new page does not appear in the sidebar of the PR preview, use the black file-changes icon in the preview to navigate directly to it. New pages do not appear in the sidebar until you update the navigation in bazel-contrib/bazel-docs.

​
Get help

  • Join the Bazel community Slack and ask in the #documentation channel. This is the best place for quick questions about the docs platform or contribution process.
  • File an issue in bazelbuild/bazel with the label type: documentation.
  • For questions about the docs platform, open an issue in bazel-contrib/bazel-docs.