Contributing to These Docs

This documentation site is built with Astro Starlight and deployed to GitHub Pages. Here’s how to contribute.

Adding a new page

1. Create a new .md or .mdx file in docs/src/content/docs/ under the appropriate directory (e.g., integrations/, guides/).
2. Add frontmatter at the top of the file with at least a title and description.
3. If needed, add the page to the sidebar configuration in docs/astro.config.mjs.

Example frontmatter

---
title: My New Guide
description: A short description of what this guide covers.
sidebar:
  order: 4
---

Running locally

cd docs
npm install
npm run dev

The site will be available at http://localhost:4321/docs/.

Building for production

npm run build

The output will be in docs/dist/.

Using MDX components

When using .mdx files, you can import Starlight’s built-in components:

import { Aside, Steps, Tabs, TabItem, Card, CardGrid } from '@astrojs/starlight/components';

These give you callouts, step-by-step lists, tabbed code examples, and card grids — no custom code needed.