docs: align wiki to the Karafka writing style
Style-only pass across 39 pages: reduce decorative bold to scannable labels and
callouts, Title Case headings, expand contractions, present tense, US English,
cut filler and --- separators, tag code fences. Commands, code, config,
COI_* env vars, paths, URLs, wiki links/anchors, and tables left unchanged.
docs: cover 0.12.0 capabilities (coi tool spec, coi top, omp, SANDBOX_CONTEXT.json)
Bring the wiki up to date with capabilities added since the last update:
- New page **Headless Orchestration (`coi tool spec`)** — the non-executing
launch-spec API for external orchestrators, incl. --continue / --resume-id /
--resume, the `prompt` field for non-embedding tools, and env/secrets model.
- New page **Resource Usage (`coi top`)** — live per-container/per-process CPU,
memory, disk and network usage; flags, examples, and how it reads cgroups.
- **Supported Tools**: add the omp (Oh My Pi) tool section; document the
~/SANDBOX_CONTEXT.json companion (context_json / context_json_file, trusted
scope only).
- **Configuration**: add context_json / context_json_file to the [tool] reference.
- Wire both new pages into Home + _Sidebar; cross-link Tmux Automation ->
Headless Orchestration.
(codex, tmpfs_size, per-host/per-destination ports, dns_servers, allowed_ports,
and git readonly were already documented.)
0.10.0 release sweep: convert removed flags/env-vars to config-key docs, add 0.9->0.10 migration section
PUSH TO MASTER ONLY WHEN v0.10.0 IS TAGGED — this describes 0.10 behavior.
- Migration-Guide: full 'Upgrading from 0.9 to 0.10' section (removed-flags
table, deleted env-var layers, claude-on-incus retirement, resume
persistence conversion, profile-beats-project-config, new opt-in features
incl. [[credentials]], hardened profile, use_sudo, ready_timeout, coi run
script, list filters)
- Configuration: hierarchy table drops the env-var and config-flag layers;
env-var section becomes a removed->replacement table; CLI flags section
rewritten around operational-only flags with a removed-flags table;
[shell] use_tmux added to the reference
- Getting-Started, Best-Practices, Architecture, Container-Lifecycle,
Container-Operations, Tmux-Automation: --persistent examples converted to
[container] persistent = true config; shutdown --timeout ->
shutdown_timeout
- Image-Management: --image/--persistent/--compression workflows converted
to config/profile equivalents (image publish keeps --compression)
- Supported-Tools: --tool selection converted to [tool] name / per-tool
profiles; new 'Tool Credentials and Third-Party Providers' section
covering the credential catalog and [[credentials]]
- Profiles: profile create flag list matches 0.10 (--inherits/--user/
--project only); profile-vs-project-config precedence note
Align docs with recent changes: list status filters, ready_timeout, [[credentials]], disk-IO value fixes
- Configuration: [container] gains shutdown_timeout/ready_timeout in the
reference; new [[credentials]] block + sections-table row (the README
already points here for the credential trust model); [limits.disk]
comments drop the invalid '/s' suffix
- Resource-and-Time-Limits: '10MiB/s' examples were rejected by validation
since v0.9.0 (e6e4af1) — now '10MiB' with the no-/s rule and SI/IEC
casing spelled out; new caveat that a pathological read rate throttles
the BOOT and can fail readiness (with the ready_timeout escape hatch)
- Container-Operations & Container-Lifecycle: coi list --running/--stopped/
--status documented (full state vocabulary, mutual exclusion, --all
interaction)
- Tmux-Automation: fix broken jq path ('.[0].name' -> '.active_containers[0].name';
output has been an object since before v0.9.0)
- Profiles: [[credentials]] row + new [container] keys in the key table
docs: fix bugs and fill content gaps from re-analysis
Bug fixes:
- Linux-Setup-Guide: fix usermod command (incus,incus-admin not
'incus incus-admin $USER' which passed incus-admin as a username)
- Image-Management: clarify Best Practices item 4 — coi image publish
captures filesystem state, not process memory; stateful = snapshots only
Content improvements:
- Home.md: add one-sentence description of what COI is before the callout
- Tmux-Automation: replace non-deterministic sleep-based CI examples with
polling helpers; add Note callout explaining why fixed sleeps are unreliable
- FAQ.md: expand Troubleshooting Quick Links from 2 to 7 entries covering
container pause/kill, privileged=true error, Docker Compose, DNS build issues
- Resource-and-Time-Limits: add prose section explaining what each limit
actually does (CPU enforce/priority, memory hard vs soft, swap semantics,
disk I/O cgroup blkio, tmpfs, runtime auto-stop)
- File-Transfer: add UID shifting note explaining automatic ownership mapping
and when to chown after pushing to system paths
- Security-Monitoring: clarify [monitoring] vs [monitoring.nft] as two
independent subsystems with separate prerequisites
- Configuration: note that forward_env is top-level in profiles vs under
[defaults] in main config
- Migration-Guide: add 4 more entries from Troubleshooting content (bool
pointer fix, settings.json deep merge, Docker Compose three-step launch,
EXDEV session save fix, UID/GID remapping)
docs: quick-win formatting pass across all wiki pages
- Add H1 title to all 16 pages that were missing one
- Add FAQ question index with 22 anchor-linked entries grouped by category
- Add See Also section to all 19 pages with curated cross-links
- Upgrade three high-risk inline warnings to blockquote callouts:
allow_local_network_access, mount parent dir, disable_protection
Add focused usage guides: Container Operations, File Transfer, Tmux Automation, Image Management