Skip to content

v0.1.0: AICaC Specification & GitHub Action

Choose a tag to compare

@eFAILution eFAILution released this 03 Feb 19:00
· 55 commits to main since this release
Immutable release. Only release title and notes can be modified.
ce09724

πŸš€ AICaC v0.1.0 - First Public Release

First official release of AI Context as Code (AICaC) - a structured approach to AI-readable project documentation.

πŸ“¦ What's Included

Specification

  • βœ… Complete AICaC whitepaper (23KB)
  • βœ… .ai/ directory convention
  • βœ… Four compliance levels
  • βœ… Token efficiency validation

GitHub Action

  • βœ… Smart auto-mode detection - automatically bootstraps or maintains
  • βœ… Setup mode - Creates PR to adopt AICaC
  • βœ… Maintain mode - Validates compliance and updates badges
  • βœ… 99 tests, 81% coverage

Badging System

  • βœ… Visual compliance indicators
  • βœ… Automatic updates
  • βœ… Four levels: None, Minimal, Standard, Comprehensive

🎯 Quick Start

Add this workflow to .github/workflows/aicac.yml:

name: AICaC Adoption

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  aicac:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v3

      - name: Check if .ai exists
        id: check
        run: |
          if [ -d ".ai" ]; then
            echo "mode=maintain" >> $GITHUB_OUTPUT
          else
            echo "mode=setup" >> $GITHUB_OUTPUT
          fi

      - uses: eFAILution/AICaC/.github/actions/aicac-adoption@v0.1.0
        with:
          mode: ${{ steps.check.outputs.mode }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          update-badge: 'true'

Important: Enable Actions to create PRs in Settings > Actions > General > Workflow permissions

πŸ“š Documentation

πŸ”¬ Validation Results

  • 40-60% token reduction vs traditional documentation
  • 15-25% faster task completion (empirically validated)
  • Direct queryability for AI assistants

πŸ™ Contributing

We welcome contributions! See the repository for details.


Making AI-readable documentation a reality.