This directory is the home of the N2API manual and project documentation. The root project README stays focused on a short introduction and the basic startup path; detailed usage and operations guidance belongs here.
- Quick start
- Basic setup
- Agent-native production operations
- Complete manual
- Development resource lifecycle
- Local startup
- Published images
- Release update notifications
- Release workflow
- Release checklist
- Repository protections
- Operator restore drill record
- Docker installation on Ubuntu 24.04 ARM64
- Production deployment
- Canonical deployment, backup, upgrade, and rollback
- Lower-level backup and upgrade details
- Portable configuration export
- Downstream Codex CLI
- Provider accounts, API keys, and routing
- Gateway limits, logs, and sticky sessions
- Required services
- UI design source of truth
- Brand assets and generation records
- Reliability and operations design
- Reliability and operations acceptance report
- Bounded metrics contract
- Production correctness design
- Production correctness implementation plan
- Production correctness acceptance report
- Agent-native operations acceptance report
- Reliability and operations plans
- Historical implementation specifications
- Historical implementation plans
The dated records under superpowers/ describe completed or partially
completed feature delivery. New cross-cutting reliability and operations work
is tracked under specs/ and plans/; the historical records remain available
for implementation context and are not a second active roadmap.
The Markdown files under docs/ use repository-relative links and keep
user-facing manuals separate from implementation records. This provides a
stable content root for a future Pages documentation site without coupling the
repository README to a specific static-site generator.