> For the complete documentation index, see [llms.txt](https://gyrinx.gitbook.io/gyrinx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gyrinx.gitbook.io/gyrinx/readme.md).

# Overview

This documentation site captures technical documentation for [Gyrinx](https://gyrinx.app).

Gyrinx is a [Django](https://www.djangoproject.com/) application running in [Google Cloud Platform](https://console.cloud.google.com/). It runs in [Cloud Run](https://cloud.google.com/run), a serverless application platform, with [Cloud SQL (specifically, Postgres)](https://cloud.google.com/sql/postgresql) for data storage. [Cloud Build](https://cloud.google.com/build) is used to deploy the application. The frontend is built with [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/).

The code is hosted here on [GitHub](https://github.com/gyrinx-app). When new code is pushed on main to the [gyrinx repo](https://github.com/gyrinx-app/gyrinx), it is automatically deployed by Cloud Build. This includes running database migrations. Code is tested automatically in [Github Actions](https://github.com/gyrinx-app/gyrinx/actions).

Analytics are through [Google Analytics](https://analytics.google.com/analytics/web/#/p470310767/reports/intelligenthome?params=_u..nav%3Dmaui).

Project tasks, issues and to-dos are managed in the [Gyrinx GitHub Project](https://github.com/orgs/gyrinx-app/projects/1).

***

## Getting Started

To get started developing Gyrinx:

1. **Begin with** [**Key Concepts**](/gyrinx/explanation/key-concepts.md) :star: - Overview of the project structure and principles
2. **Set up your environment** - Follow the setup guide in the GitHub README
3. **Dive deeper**:
   * [Models and Database](/gyrinx/technical-reference/models-and-database.md) - Understanding the data layer
   * [Frontend Development](/gyrinx/explanation/frontend-development.md) - Working with templates and styling
   * [Testing](/gyrinx/explanation/testing.md) - Writing and running tests
   * [History Tracking](/gyrinx/technical-reference/history-tracking.md) - Understanding audit trails

## Operations

For deployment and operational information:

* [Deployment](/gyrinx/operations/deployment.md) - How the application is deployed and managed
* [Operational Overview](/gyrinx/operations/operational-overview.md) - Infrastructure and monitoring
* [Runbook](/gyrinx/operations/runbook.md) - Live operational procedures (team access only)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gyrinx.gitbook.io/gyrinx/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.