Skip to main content

Codomyrmex Agents — src/codomyrmex/documentation/docs

Version: v1.3.0 | Status: Active | Last Updated: March 2026

Purpose​

Documentation tooling, generated references, and publishing assets for Docs.

Active Components​

  • PAI.md – Project file
  • README.md – Project file
  • SPEC.md – Project file
  • development/ – Directory containing development components
  • index.md – Project file
  • intro.md – Project file
  • modules/ – Directory containing modules components
  • project/ – Directory containing project components
  • technical_overview.md – Project file
  • tutorials/ – Directory containing tutorials components

Operating Contracts​

  • Maintain alignment between code, documentation, and configured workflows.
  • Ensure Model Context Protocol interfaces remain available for sibling agents.
  • Record outcomes in shared telemetry and update TODO queues when necessary.

Key Files​

  • AGENTS.md - Agent coordination and navigation
  • README.md - Directory overview
  • PAI.md
  • README.md
  • SPEC.md
  • index.md
  • intro.md
  • technical_overview.md

Dependencies​

  • Inherits dependencies from the parent module. See pyproject.toml or package.json for global dependencies.

Development Guidelines​

  • Follow the universal agent protocols defined in the root AGENTS.md.
  • Adhere to the Python PEP 8 style guide and project-specific linting rules.
  • Ensure all new features are accompanied by corresponding tests (zero-mock policy).
  • 📁 Parent Directory: documentation - Parent directory documentation
  • 🏠 Project Root: ../../../../README.md - Main project documentation