docs

AIXCL Documentation

This directory contains all project-wide documentation organized by audience and purpose.

Documentation Structure

User Documentation (user/)

Documentation for end users and operators:

• setup.md - Installation and setup guide
• usage.md - Usage guide and examples

Developer Documentation (developer/)

Documentation for contributors and developers:

• contributing.md - Contribution guidelines
• development-workflow.md - Development workflow and best practices
• adding-services.md - Checklist for adding new services to the stack
• opencode-setup.md - OpenCode CLI (cn) with Ollama and agentic mode
• Moved to docs/developer/: AGENTS.md and DEVELOPMENT.md - Agent operating contracts and workflow rules

Operations Documentation (operations/)

Documentation for operations and performance tuning:

• security.md - Rootless container operations and security isolation
• ollama-performance-tuning.md - Detailed Ollama performance tuning guide
• ollama-tuning-summary.md - Executive summary of Ollama optimizations
• model-recommendations.md - Model size recommendations and configurations

Architecture Documentation (architecture/)

Documentation about system architecture and design:

• governance/ - Governance model, invariants, profiles, and service contracts
  • GOVERNANCE_COMPLIANCE.md - Session compliance confirmation and checklist

Reference Documentation (reference/)

Reference materials and specifications:

• manpage.txt - Command-line reference
• See root SECURITY.md - Security policy and practices

Configuration Documentation (config/)

Configuration templates and profiles:

• .env.example - Environment configuration template
• profiles/ - Profile-specific configurations (usr, dev, ops, sys)

GitHub Templates (.github/)

GitHub-specific templates:

• PULL_REQUEST_TEMPLATE.md - Pull request template
• ISSUE_TEMPLATE/ - Issue templates (bug report, feature request, task)

Component-Specific Documentation

Component-specific documentation remains with their respective components:

• Tests: tests/README.md and component-specific test docs
• Scripts: scripts/*/README.md files
• Libraries: lib/README.md files

Root-Level Documentation

The following files remain at the project root (standard practice):

• README.md - Main project overview and quick start
• CHANGELOG.md - Project changelog
• SECURITY.md - Security policy and practices

Quick Links

• Getting Started: Start with user/setup.md
• Contributing: See developer/contributing.md
• Architecture: Explore architecture/governance/
• Performance: Check operations/ollama-performance-tuning.md and operations/model-recommendations.md
• Configuration: See ../config/README.md