Read the N2API Wiki for setup, configuration, and operations. The root README is a short project overview; this directory holds the version-controlled documentation sources.
- Wiki home
- Quick start and 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.
Edit these sources through the normal worktree, review, and PR workflow.
After merging, publish the following files from the merged revision to the
separate N2API.wiki.git repository:
| Repository source | Wiki file |
|---|---|
docs/wiki/Home.md |
Home.md |
docs/wiki/Getting-Started.md |
Getting-Started.md |
docs/wiki/_Sidebar.md |
_Sidebar.md |
docs/manual.md |
Manual.md |
docs/agent-operations.md |
Operations.md |
docs/development.md |
Development.md |
docs/release-checklist.md |
Release-Checklist.md |
docs/repository-protections.md |
Repository-Protections.md |
docs/restore-drill-record.md |
Restore-Drill-Record.md |
When copying a manual, rewrite relative Markdown links to the corresponding
Wiki page names above without the .md extension, preserving heading anchors.
Link other repository files to their absolute GitHub URLs. Keep code examples
unchanged. Preserve unrelated Wiki pages, commit only the listed pages, and
publish with a normal push. Verify the published pages and links from a fresh
clone. The Wiki describes main; release users should also check their image's
source revision and release notes.
Implementation specifications, plans, and acceptance records remain in the repository. Do not treat publication as new runtime or production evidence.