---
title: Documentation PR
description: How to submit documentation pull requests
icon: GitPullRequestCreate
---
import { Steps, Step } from 'fumadocs-ui/components/steps';
Improving documentation is one of the most valuable ways to contribute. Follow this workflow to submit your changes.
## Submission Workflow
<Steps>
<Step>
### Crate a Fork
Before becoming a maintainer, you need a fork to modify the documentation.
</Step>
<Step>
### Local Preview
Vane's documentation is built with [Fumadocs](https://www.fumadocs.dev/). Always preview your changes locally before pushing.
```bash
# Install dependencies (if not done)
pnpm install
# Start dev server
pnpm dev
```
Visit `http://localhost:3000` to verify your changes.
</Step>
<Step>
### Commit Messages
We follow [Conventional Commits](https://www.conventionalcommits.org/).
For documentation, use the `docs:` prefix.
- **Good**: `docs: add mermaid diagram to L7 adapter`
- **Good**: `docs(l4): fix broken link in tcp guide`
- **Bad**: `update docs`
</Step>
<Step>
### Submit PR
Push your branch to GitHub and open a Pull Request against `main`.
Ensure the CI checks (Lint, Build) pass.
</Step>
</Steps>
## Checklist
- [ ] **Frontmatter**: Does the file have `title`, `description`, and `icon`?
- [ ] **Links**: Are all relative links (`../`) correct?
- [ ] **Images/Diagrams**: Do Mermaid diagrams render correctly in the preview?
- [ ] **Grammar**: Is the English clear and typo-free?
- [ ] **Format**: Did you run `pnpm fmt`?