Skip to main content

Overview

project-config.yaml contains project-specific settings shared across the team. This Level 2 configuration file is committed to the repository and allows projects to customize AIOX behavior without modifying framework defaults.
Location
string
.aiox-core/project-config.yaml
Level
string
L2 (Project)
Mutability
string
Editable by project maintainers
Git Status
string
Committed to repository
Reference: ADR-PRO-002 — Configuration Hierarchy

Schema Reference

Project Metadata

project
object
required
Project installation metadata (project portion)

Documentation Paths

documentation_paths
object
Project documentation structure (Section 2)

GitHub Integration

github_integration
object
GitHub integration configuration (Section 8)

CodeRabbit Integration

coderabbit_integration
object
CodeRabbit AI code review integration (Section 9)

Squads System

squads
object
Agent squad configuration (Section 10)

Logging & Status

logging
object
Logging and status configuration (Section 7)

Additional Features

story_backlog
object
Story backlog management
story_backlog:
  enabled: true
  location: "docs/stories/backlog"
  prioritization: "value_risk"
pv_mind_context
object
PV Mind Context (personal voice/persona system)
pv_mind_context:
  enabled: true
  location: "outputs/minds/pedro_valerio"
  features:
    persona_voice: true
    technical_depth: "advanced"
    communication_style: "structured"
auto_claude
object
Auto-Claude automation configuration (Section 13)

Example Configuration

# ============================================
# AIOX Project Configuration (Level 2)
# ============================================

project:
  type: EXISTING_AIOX
  installed_at: "2025-01-14T00:00:00Z"
  version: "2.1.0"

documentation_paths:
  qa_dir: "docs/qa"
  prd_file: "docs/prd.md"
  prd_version: "v4"
  stories_dir: "docs/stories"
  dev_load_always_files:
    - "docs/framework/coding-standards.md"
    - "docs/framework/tech-stack.md"

github_integration:
  enabled: true
  features:
    pr_creation: true
    issue_management: true
  pr:
    title_format: "conventional"
    include_story_id: true
    conventional_commits:
      enabled: true
      default_type: "feat"

coderabbit_integration:
  enabled: true
  self_healing:
    enabled: true
    type: "full"
    max_iterations: 3
  severity_handling:
    CRITICAL: "auto_fix"
    HIGH: "auto_fix"
    MEDIUM: "document_as_debt"

logging:
  decision_logging:
    enabled: true
    format: "adr"
  project_status:
    enabled: true
    auto_load_on_agent_activation: true

auto_claude:
  enabled: true
  version: "3.0"
  worktree:
    enabled: true
    auto_create: "on_story_start"

Best Practices

  • Commit project-config.yaml to repository
  • Document all project-specific customizations
  • Review changes in PRs like any other code
  • Keep settings minimal and intentional
  • Override framework defaults only when necessary
  • Use descriptive comments for complex settings
  • Test configuration changes in isolation
  • Maintain backward compatibility for team members
  • Never commit secrets or API keys
  • Use environment variables for sensitive data
  • Document required environment variables
  • Use local-config.yaml for personal credentials

Reference: .aiox-core/project-config.yaml | ADR-PRO-002

Build docs developers (and LLMs) love