Contributing to Valkey GLIDE Documentation

June 17, 2026 · View on GitHub

Thank you for your interest in contributing to the Valkey GLIDE documentation!

Branches Overview

Branch	Purpose
`main`	Integration branch — all PRs target here
`public`	Production — deploys the live site at glide.valkey.io

In general:

Open all PRs against main.
On release day, main is merged onto public triggering a deployment.
Only urgent fixes are accepted directly into public.

Getting Started

Fork the repository

Clone your fork:

git clone git@github.com:<your-username>/valkey-glide-docs.git
cd valkey-glide-docs

Install dependencies:
```
pnpm install
```
Start the dev server:
```
pnpm dev
```

Making Changes

Create a branch from main:

git checkout -b your-username/short-description

Make your changes in src/content/docs/
Verify your changes build correctly:
```
pnpm build
```
Format your code:
```
pnpm format
```

Commit Guidelines

All commits must be signed off to certify the Developer Certificate of Origin (DCO):

git commit --signoff -m "Your commit message"

Submitting a Pull Request

Push your branch to your fork
Open a PR targeting main
Ensure CI checks pass (build, formatting, link validation)
Feel free a ping a maintainer for review.

Code Standards

Run pnpm format before committing
Run pnpm build to catch broken internal links
Use relative links for internal pages
Every .mdx file must include title and description in frontmatter

Reporting Issues

For any bugs, issues, or suggestions feel free to create an issue on our Github.

AI Agent Support

This project includes an AGENTS.md file that provides AI coding agents with project context, architecture details, build commands, and content guidelines.