Skip to content

Codex Documentation HubΒΆ

Version: v0.3.0
Last Updated: 2026-10-24
Status: Active documentation source-of-truth for the current branch

Current operational truth: use README.md, docs/, and mkdocs.yml as the live documentation source. Historical narrative pages, older rebuild snapshots, and phase reports remain archive evidence and are not the current branch state unless explicitly labeled historical. Current status page: docs/status/GITHUB_PAGES_STATUS.md Archive policy: docs/archive/README.md

Welcome to the documentation for Aries-Serpent/codex, an ML platform, repository-automation workspace, and persistent decision-and-learning system.


Getting StartedΒΆ

Choose your entry point based on your role:

Role Entry point
Contributor Contributor onboarding
ML engineer ML engineer onboarding
GitHub Actions maintainer Workflow maintainer onboarding
Agent/session operator Agent/session operator onboarding

Shared orientation:


Core Documentation SectionsΒΆ

πŸ“š Reference MaterialsΒΆ

  • Architecture β€” Detailed technical architecture and component diagrams
  • API Reference β€” Complete API documentation and examples
  • Changelog β€” Release notes and version history
  • Roadmap β€” Planned features and improvements

πŸš€ Operations & DeploymentΒΆ

πŸ§ͺ Testing & QualityΒΆ

πŸ“¦ Integration & PackagingΒΆ

πŸ’Ύ Configuration & SetupΒΆ


Cognitive Brain (AI Agents Start Here)ΒΆ

The cognitive brain supplies orchestration, memory, and decision-support components. Autonomous actuation is policy-scoped and environment-dependent; an implemented component does not by itself prove that it is enabled or deployed. See the ecosystem evidence matrix.

Unified Navigation SystemΒΆ

  • Cognitive Map β€” Complete architecture, components, flows, and dependencies
  • Dashboard β€” Live status, current work, blockers, and metrics
  • Agent Orchestration β€” Multi-agent workflow management

Key CapabilitiesΒΆ

  • Context Continuity β€” Maintain understanding across sessions
  • Efficient Navigation β€” Quick discovery of components and relationships
  • Duration-Aware Planning β€” Maximize work within token/time budgets
  • Guarded operation β€” Agent actions remain bounded by runtime policy, approval classes, kill switches, and environment permissions
  • Memory Management β€” Hippocampus-cortex inspired STM/LTM system

Operational TemplatesΒΆ

Reusable templates for common operations (migrations, hardening, planning):

Before using a template: Review Templates Guide for prerequisites and role guidance.


CI Rescue & ReliabilityΒΆ

Automated Failure RecoveryΒΆ


Accountability & StatusΒΆ


Deployment Rings & RolloutΒΆ

This repository uses staged rollout rings:

Ring Status Purpose
0A_base_ / 0B_base_ Active Dev Unstable knobs, experimental features
0C_base_ Integration Multiple features landing together
0D_base_ Release Candidate Explainable to Engineering and Product
main Production Canonical internal alpha product

Quick ReferenceΒΆ

Need Find It Here
Quick start Quickstart Guide
How to contribute CONTRIBUTING.md
API documentation API Reference
System architecture Architecture
Deployment steps Deployment Guide
Troubleshoot an issue Troubleshooting
Review changes Changelog
Find an example Examples
Setup development env Setup Guide
Report a bug GitHub Issues

InstallationΒΆ

pip install -e .

ConventionsΒΆ

  • Keep docs small and composable
  • Use fenced code blocks for proposed patches
  • Prefer citations to live repo files when referencing code
  • Follow "Keep a Changelog" format with Unreleased section

Need Help?ΒΆ


Last updated: 2026-10-24