Documentation Coverage Map
This is the working coverage checklist for the documentation foundation. It answers whether an actual repository concern has a canonical owner and whether that owner is an operating guide, a catalog entry or an explicitly recorded gap. It does not claim every page is complete.
Update this map when adding a workspace, architectural dependency, cross-cutting configuration or CI workflow. The dependency inventory and command reference explain how to inspect manifests and scripts at their source; this page maps their roles to useful explanations.
Workspaces and maintained surfaces
| Repository surface | Canonical owner | Coverage check |
|---|---|---|
apps/game-client | Game Client and architecture | Routes, bundled content, i18n, local state, errors, offline boundary and operations |
apps/backoffice-client | Backoffice Client | Home/About proof routes, shared shell, primitive theme overrides, ports/tests and missing auth/data boundaries |
packages/ui | Packages and Design System | Source-subpath export, consumers, cn, token story and current no-emit build |
packages/design-system | Packages and Design Tokens | CSS export, token layers, Tailwind mappings and change workflow |
tools/storybook | Storybook | Story discovery, Vite aliases, docgen, themes, browser/a11y tests |
tools/e2e | E2E Runner | Target selection, server prerequisite, artifacts, a11y helper and production scope |
tools/web-docs-client and docs | Web Docs Client | Generation/build/preview, navigation, LLM index, diagrams and verification |
tools/diagram-generator | Diagram Generator | Dependency-cruiser configs, Graphviz prerequisite and generated outputs |
| Root orchestration/config | Engineering, CI and Project workflow | Pinned tools, task graph, hooks, affected mapping and contribution gates |
Configuration ownership
| Evidence | Canonical documentation | What a reviewer should find there |
|---|---|---|
.nvmrc, engines.node, packageManager, pnpm-workspace.yaml, lockfile | Node.js and pnpm | Supported runtime range, exact pins, catalogs, workspace protocol, frozen install and upgrades |
Root/workspace tsconfig*.json | TypeScript | Inheritance, aliases, includes/excludes and transforms |
turbo.json, scripts/orchestrator | Turborepo and CI | Task dependencies, cache inputs/outputs and workflow mapping |
biome.json, biome.root.json | Biome | Root/workspace ownership, lint/fix commands and exclusions |
| App Next/PostCSS config | Next.js and Tailwind/PostCSS | App Router/Turbopack boundaries and CSS integration |
| Vitest/Playwright/Storybook configs | Testing and its layer guides | What each runner proves, prerequisites and CI execution |
lighthouserc.json, scripts/lighthouse/** | Web Quality and Lighthouse | Mobile profile, explicit routes, structured informational reporting and failure semantics |
renovate.json | Dependency Management and Renovate | Repository policy versus provider state |
.github/workflows, .github/actions | CI, Deployment and Services | Event flow, permissions, credentials by name, validation and notifications |
| VitePress config/scripts | Web Docs Client | Base path, content scan, navigation, LLM copies and Mermaid rendering/verification |
Dependency coverage rule
Use the dependency audit to enumerate current declarations. Dependencies with recurring Kartuli conventions have a dedicated guide or capability page:
- TypeScript, Turbo, Node/pnpm, Next.js, React, Tailwind/PostCSS, Vite/VitePress, Git/Lefthook and Biome have technology guides.
- TanStack/IndexedDB, i18n, Base UI, Zod, Serwist and Motion/icon/class helpers have library guides.
- Vitest, Testing Library, Happy DOM, Playwright, axe, Storybook addons, V8 coverage and Lighthouse are owned by Quality/Tools.
- dependency-cruiser, VitePress/diagram dependencies and provider integrations are owned by their Tool or Service pages.
Small helpers, type packages and renderer/runtime peers can share the Toolchain Support guide unless they acquire a separate project-specific lifecycle or boundary. A declaration is not proof of runtime use; guides name actual consumers and call out declared-but-unverified roles.
Workflow and service coverage
| Capability | Repository evidence | Canonical owner | Known gap that remains visible |
|---|---|---|---|
| PR validation | Staging orchestrator, affected mapper, validation actions | CI, GitHub | Main ruleset verified on 2026-10-06; changes require a fresh settings read |
| App preview/production | Reusable staging and two production workflows | Deployment, Vercel | Production path filters cover both shared packages; rollback is undocumented |
| Docs production | Pages build/deploy/post-deploy E2E | Deployment, GitHub | Pages environment/settings require verification |
| Remote cache | Turbo config, Actions cache, TURBO_* names | Remote Build Cache | Hit/auth/retention state is external |
| Dependency updates | Catalog/lockfile, Renovate policy and dashboard #28 | Dependency Management, Renovate | Discovery/PRs verified; inherited settings/timezone remain external |
| Notifications | Telegram composite action and caller workflows | Telegram | Destination/permissions/delivery are external |
| Static/review services | SonarQube Cloud gate report, CodeRabbit review/status and GitHub ruleset | Service pages and Code Review | Gate enforcement verified; provider settings and review freshness require separate evidence |
Implementation-pattern coverage
| Pattern | Canonical owner | Review trigger |
|---|---|---|
| Bundled learning-content ingestion and joins | Game Client architecture | Schema, source, locale, lesson/module relationship changes |
| Browser identifiers, activity storage and logs | Data & Privacy | New field, retention, sync, telemetry or recovery behavior |
| Locale routing and preference cookie | i18next and Game Client | Supported locale, proxy matcher, cookie or navigation changes |
| Token layers and shared/app component boundary | Design System | Token, theme, font, responsive or shared-component changes |
| Test selection and evidence | Testing | New runner, environment, exclusion, artifact or CI execution path |
| Agent/document context hierarchy | AI Development | Bootstrap, canonical owner or generated-index changes |
Open coverage gaps
These are known incomplete capabilities, not undocumented implemented systems:
- Backoffice authentication, authorization, editor data flow and recovery are not implemented.
- Full offline cold-start/update behavior is not demonstrated by the current Serwist wrapper.
- Analytics policy, telemetry taxonomy, consent, retention and centralized observability are planned.
- Release rollback/promotion, incident response, backup and recovery runbooks are not established.
- Provider-console settings, ownership and secret rotation need authorized manual verification.
- Local Backoffice preview/E2E port alignment remains out of scope.
Audit procedure
- Compare
pnpm-workspace.yamland every workspace manifest with the workspace and dependency tables. - Inspect root/workspace scripts and check that their operational caveats have a canonical guide.
- Review root/scoped configs and
.github/workflowsfor a canonical capability owner. - Search source for new persistence, cookies, network calls, environment variables and provider SDKs.
- Add depth where a contributor cannot safely perform and verify a common change.
- Generate/check the LLM index, build/preview the site, inspect navigation and run full validation.
Record external facts as manual verification, and preserve gaps rather than filling them with provider defaults or intended behavior.