Skip to content

Module ai working Architecture

github-actions[bot] edited this page Sep 28, 2026 · 2 revisions

Navigation: Home > Modules

Architecture β€” ai_working Module

Overview

The ai_working module is a documentation and planning artifact container. It holds no runtime C++ code. Its architecture is purely organizational: a governed directory structure that allows AI agents, maintainers, and CI governance tooling to locate, validate, and archive working materials produced during active development cycles.

Context and Purpose

ThemisDB uses wave-driven development (Wave A β†’ B β†’ C β†’ D) coordinated by AI agents. Each wave produces planning documents, execution reports, gap analysis packets, and completion summaries. The ai_working module provides the canonical storage location for these artifacts under repository governance.

Components

Component Path Responsibility
Root working directory ai_working/ Wave planning, execution reports, agent collaboration artifacts
Module governance docs src/ai_working/ README, ARCHITECTURE, ROADMAP, CHANGELOG, AUDIT, SECURITY, and enhancement docs
Test placeholder tests/ai_working/ Reserved for future test coverage of working-context utilities
Benchmark placeholder benchmarks/ai_working/ Reserved for future benchmark coverage

Artifact Lifecycle

Created (wave active)
    |
    v
Used (agent references artifact during execution)
    |
    v
Superseded (wave completes or document is no longer current)
    |
    v
Archived to docs/ARCHIVED/ai-working-history/

All artifacts that are no longer active are moved to docs/ARCHIVED/ rather than deleted, to preserve planning history.

Interfaces

  • No public C++ API.
  • Governance tooling (e.g., scripts/check_module_direct_doxygen.py) treats this module as a documentation-only module.
  • CI doc-metadata gates validate the presence of required governance files in src/ai_working/.

Failure Paths

  • Missing required governance documents β†’ CI doc-metadata gate fails with LOW compliance score.
  • Stale placeholders that do not reflect module purpose β†’ documentation drift finding.

Non-Goals

  • Runtime execution: this module provides no production code paths.
  • API surface: no public headers or exported symbols.
  • Performance-critical paths: there are no latency or throughput requirements.

ThemisDB 1.9.0-beta Β· Home Β· Module-Index Β· GitHub Β· Issues

ThemisDB Wiki

🏠 Overview

πŸ“š Compendium

πŸš€ Getting Started

πŸ“– Tutorials

πŸ“— User Guide

βš™οΈ Operations & Security

πŸ“Ÿ Ops Runbooks

πŸ—οΈ Architecture

πŸ“ ADRs

πŸ”§ Contributing

πŸ“‹ Governance

πŸ” Audit

🧩 Plugins

πŸ”Œ Adapters

πŸ’‘ Examples

πŸ“¦ Client SDKs

πŸŽ“ Training

πŸ› οΈ Tools

πŸ€– Developer LLM Wiki

Clone this wiki locally