# Xquik docs

This repository is the public documentation site. Treat every committed file as
public-facing unless it is explicitly a standard open-source project file.

Every commit reduces handwritten test LOC & non-test code LOC separately.
Both deltas must be negative against the parent. No category offsets another.
Count every language & location, including shell scripts & development tooling.
Test-only scripts & helpers count as tests; other scripts count as non-test code.
Report before, after & delta for both categories. Count each line once.
Exclude generated code, formatting, minification, moves, renames & reclassification.
Preserve valuable tests, docs, assertions, coverage, guards, diagnostics & behavior.

## Confidentiality

- Do not commit private handoffs, research, prompts, audit logs, or scratch files.
- Keep `DOCS_QUALITY_POLL.md` local only. It is ignored by Git and must never
  be force-added.
- Do not publish private implementation, infrastructure, routing, cost, or
  deployment details.
- Use generic terms such as "own infrastructure", "read service", "write
  service", "browser service", or "network egress service".
- Remove confidential details from the staged diff before committing.

## Docs workflow

- Pull latest changes and inspect `git status` before edits.
- Preserve unrelated user changes.
- Keep docs `openapi.yaml` aligned with `/Users/burak/Developer/xquik/openapi.yaml`
  unless a documented reason requires them to differ.
- Run static docs checks only unless the user explicitly asks for local servers
  or browser checks.
- Prefer `bun run test:agent-docs`, `bunx --bun mint validate`, and
  `bunx --bun mint broken-links`.
- If adding a root Markdown support file, either keep it ignored or make it an
  intentional public docs page with frontmatter and navigation.