Skip to content

Latest commit

Β 

History

History
51 lines (43 loc) Β· 1.87 KB

File metadata and controls

51 lines (43 loc) Β· 1.87 KB

Codomyrmex Agents β€” docs/getting-started/tutorials

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

Purpose

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

Active Components

  • PAI.md – Project file
  • README.md – Project file
  • SPEC.md – Project file
  • connecting-pai.md – Project file
  • creating-a-module-01-scaffold.md – Project file
  • creating-a-module-02-implement.md – Project file
  • creating-a-module-03-test.md – Project file
  • creating-a-module-04-document.md – Project file
  • creating-a-module.md – Project file
  • running-tests.md – Project file
  • using-mcp-tools.md – Project file

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
  • connecting-pai.md
  • creating-a-module-01-scaffold.md
  • creating-a-module-02-implement.md
  • creating-a-module-03-test.md
  • creating-a-module-04-document.md
  • creating-a-module.md
  • running-tests.md
  • using-mcp-tools.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).

Navigation Links

  • πŸ“ Parent Directory: getting-started - Parent directory documentation
  • 🏠 Project Root: ../../../README.md - Main project documentation