# Weaviate Database

Here you can find guides on how to work with the Weaviate Database [source code](https://github.com/weaviate/weaviate).

::::card-grid
:::card{title="Code structure and style" href="/guides/weaviate-database-structure" icon="code"}
Learn Weaviate's codebase organization, coding standards, and style guidelines for consistent development.
:::

:::card{title="CI/CD philosophy" href="/guides/weaviate-database-cicd" icon="refresh-cw"}
Understand our continuous integration and deployment approach, including automated testing and release processes.
:::

:::card{title="Tests" href="/guides/weaviate-database-tests" icon="test-tube"}
Explore Weaviate's testing strategy, including unit tests, integration tests, and quality assurance practices.
:::

:::card{title="Development setup" href="/guides/weaviate-database-setup" icon="settings"}
Set up your local Weaviate development environment with all necessary tools and dependencies.
:::

:::card{title="Parsing objects & resolving references" href="/guides/weaviate-database-parsing-cross-refs" icon="workflow"}
Deep dive into how Weaviate parses objects and resolves cross-references internally.
:::

:::card{title="Runtime configurations" href="/guides/weaviate-database-support-new-runtime-configs" icon="sliders-horizontal"}
Learn how to add new runtime configuration options to Weaviate's configuration system.
:::
::::

## 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`.