# 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](development.md)
3. **Make your changes** in accordance with our [style guidelines](style-guide.md)
4. **Test locally** with `yarn build` to ensure everything works
5. **Submit a pull request** with a clear description of your changes

## Documentation guides

::::card-grid
:::card{title="Setup and editing guide" href="/guides/weaviate-docs-development" icon="code"}
Learn how to build docs locally, use components like CardsSection, handle linking, and work with our Docusaurus setup.
:::

:::card{title="Style guidelines" href="/guides/weaviate-docs-style-guide" icon="pen-tool"}
Writing guidelines, tone, formatting standards, and content conventions to ensure consistency across all Weaviate documentation.
:::

:::card{title="Optimizing docs for LLMs" href="/guides/weaviate-docs-llms" icon="bot"}
Best practices for making documentation AI-friendly, including content structure, llms.txt implementation, and writing effective frontmatter.
:::
::::

## Questions and feedback

Have a question or feedback? Here's how to reach us.

::::card-grid
:::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"}
Ask questions and connect with other developers on our **Community forum**.
:::

:::card{title="Support" href="/guides/support-overview" icon="life-buoy"}
Weaviate Cloud user or customer? Find the right channel on the **Support page**.
:::
::::

## Related pages

- [Agents](./agents-index.md)
- [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md)
- [APIs](./apis-index.md)
- [Authorization and authentication](./authorization-and-authentication-index.md)
- [Benchmarks](./benchmarks-index.md)
- [Best practices](./best-practices-index.md)
- [Client libraries](./clients-index.md)
- [Client Libraries / SDKs](./client-libraries-index.md)
- [Cloud](./cloud-index.md)
- [Cloud account management](./cloud-account-management-index.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.