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
Section titled “Quickstart”- Use the docs repository on GitHub
- Users should fork the repository
- Weaviate employees don't need to fork the repo and should create a new branch
- Set up your local environment following our development guide
- Make your changes in accordance with our style guidelines
- Test locally with
yarn buildto ensure everything works - Submit a pull request with a clear description of your changes
Documentation guides
Section titled “Documentation guides”Setup and editing guide
Learn how to build docs locally, use components like CardsSection, handle linking, and work with our Docusaurus setup.
Style guidelines
Writing guidelines, tone, formatting standards, and content conventions to ensure consistency across all Weaviate documentation.
Optimizing docs for LLMs
Best practices for making documentation AI-friendly, including content structure, llms.txt implementation, and writing effective frontmatter.
Questions and feedback
Section titled “Questions and feedback”Have a question or feedback? Here's how to reach us.