# TiDB Labs Knowledge Base

This directory is the durable knowledge base for the `labs.tidb.io` monorepo.
Use it as the home for cross-cutting repository context. The root
[`AGENTS.md`](../AGENTS.md) is only the directory card that points here.

## Primary Entry Points

- [`../ARCHITECTURE.md`](../ARCHITECTURE.md): runtime topology and the key
  request flows
- [`DESIGN.md`](./DESIGN.md): design-doc layer and authoring rules
- [`FRONTEND.md`](./FRONTEND.md): frontend stack, local dev modes, and
  validation
- [`PRODUCT_SENSE.md`](./PRODUCT_SENSE.md): product framing and user outcomes
- [`RELIABILITY.md`](./RELIABILITY.md): runtime dependencies, CI, and
  deployment caveats
- [`SECURITY.md`](./SECURITY.md): auth surfaces, secrets, and security review
- [`PLANS.md`](./PLANS.md): durable plan and tech-debt structure
- [`QUALITY_SCORE.md`](./QUALITY_SCORE.md): rubric for judging doc quality

## Structured Sections

- [`design-docs/index.md`](./design-docs/index.md): cross-cutting design notes
- [`product-specs/index.md`](./product-specs/index.md): product-facing behavior
  and state transitions
- [`exec-plans/active/README.md`](./exec-plans/active/README.md): active
  multi-step plans
- [`exec-plans/completed/README.md`](./exec-plans/completed/README.md):
  archived plans
- [`exec-plans/tech-debt-tracker.md`](./exec-plans/tech-debt-tracker.md):
  repo-wide debt that should stay visible between tickets
- [`generated/db-schema.md`](./generated/db-schema.md): schema inventory and
  generated-doc placeholder
- [`references/index.md`](./references/index.md): short reference notes for
  common tools and conventions

## Operating Rules

- Put long-lived repository knowledge here, not in Linear comments.
- Prefer one topic per document and link instead of repeating content.
- Update the most specific document that became stale in the same change as the
  code or workflow update.