---
title: "Weaviate Documentation"
description: "Complete guide for contributing to Weaviate's documentation"
url: https://docs.weaviate.io/contributor-guide/weaviate-docs
---

# Weaviate Documentation

Welcome to the Weaviate documentation contributor guide! Whether you're fixing typos, adding new tutorials, or improving existing content, this section provides everything you need to contribute effectively to our documentation.

Our documentation is built with Docusaurus and includes comprehensive guides, API references, tutorials, and examples. Your contributions help thousands of developers understand and use Weaviate more effectively.

## Quickstart

1. **Use the [docs repository](https://github.com/weaviate/docs)** on GitHub

   - Users should fork the repository
   - Weaviate employees don't need to fork the repo and should create a new branch

2. **Set up your local environment** following our [development guide](https://docs.weaviate.io/contributor-guide/weaviate-docs/development)

3. **Make your changes** in accordance with our [style guidelines](https://docs.weaviate.io/contributor-guide/weaviate-docs/style-guide)

4. **Test locally** with `yarn build` to ensure everything works

5. **Submit a pull request** with a clear description of your changes

## Documentation guides

[Setup and editing guide](https://docs.weaviate.io/contributor-guide/weaviate-docs/development): Learn how to build docs locally, use components like CardsSection, handle linking, and work with our Docusaurus setup.

[Style guidelines](https://docs.weaviate.io/contributor-guide/weaviate-docs/style-guide): Writing guidelines, tone, formatting standards, and content conventions to ensure consistency across all Weaviate documentation.

[Optimizing docs for LLMs](https://docs.weaviate.io/contributor-guide/weaviate-docs/llms): Best practices for making documentation AI-friendly, including content structure, llms.txt implementation, and writing effective frontmatter.
