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

# Overview

[![docs-ci](https://github.com/cynthiawang109-sudo/taskflow-docs/actions/workflows/docs-ci.yml/badge.svg)](https://github.com/cynthiawang109-sudo/taskflow-docs/actions/workflows/docs-ci.yml) System documentation for **TaskFlow**, a fictional project-management SaaS. This repository is the source of truth for how TaskFlow is built and operated; other workspace projects (code-reviewer, release-assistant) read it but never modify it as a side effect of their own work.

Part of [ai-workspace-kit](https://github.com/cynthiawang109-sudo/ai-workspace-kit). All content is original and fictional.

## Contents

| File                     | What it covers                                                    |
| ------------------------ | ----------------------------------------------------------------- |
| `system-overview.md`     | Components, data flow, and the boundaries between services        |
| `deployment.md`          | Environments, release mechanics, rollback                         |
| `incident-runbook.md`    | First-response steps for the common failure modes                 |
| `architecture.md`        | Request lifecycle, async work, scaling, failure domains           |
| `authentication.md`      | Sessions, API tokens, service-to-service auth, admin MFA          |
| `observability.md`       | Logs, metrics, traces, and the alerts that page                   |
| `security.md`            | PII rules, secrets, dependency policy, review requirements        |
| `environments.md`        | Per-environment data, secrets, and access rules                   |
| `backup-and-recovery.md` | PostgreSQL backups, PITR, restore drills                          |
| `adr/`                   | Architecture decision records (PostgreSQL, cursor pagination, RQ) |

API-level contracts (endpoints, payloads, data model) live in the sibling repo `taskflow-api-docs`.


---

# 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 by asking a question.

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

```
GET https://taskflow-1.gitbook.io/taskflow-docs/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 `automate deployments from our CI pipeline` 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.
