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: rebrand to Coi (drop all-caps COI; Coi primary, coi command)
COI -> Coi across all pages; sidebar + Home first-mention use "Coi (Code on Incus)".
Preserved: COI_* env-var names and the literal "# COI Sandbox ..." context markers
(they document the actual on-disk marker text). Lowercase coi commands unchanged.
docs: dedicated Updating COI page (binary + detection databases)
Promote update docs out of System-Health-Check into a standalone
Updating-COI page so it is discoverable on its own (prompted by #821).
- Document coi update / update core / update patterns, including the
GTFOBins + Sigma detection-database refresh the old docs omitted.
- Add troubleshooting for the Sigma/GTFOBins git pull --ff-only failure
(remove the clone dir and re-run) and the v0.11.0 doubled-version bug.
- Self-Update and System-Health-Check#updating-coi now point to the new
page; update Home, Sidebar, and Image-Management links.
docs: reflect merged kernel-surface hardening PR (#787) final state
- Threat model: fail-closed guarantee for profile-pinned keys, new Kernel
mitigations health check, Incus recommended-floor now advisory (stays OK),
hardened profile's 4h session cap.
- Profiles: hardened preset table gains reduce_kernel_surface and
limits.runtime.max_duration rows; wording updated (the preset now carries
new enforcement, not only pre-existing controls).
- System health check: SYSTEM sample output + What's Checked cover kernel
build age, kernel mitigations, and distro support; Incus row notes the
6.7+ advisory.
docs: document the universal --json output alias (#765)
Every command with --format text|json now also accepts --json (alias for
--format json; --json wins over --format text). Authoritative note + full
command list in Container Operations; inline shorthand on Image/Snapshot/
Health pages. Notes the coi container exec exception (--format json|raw).
0.11.2: firewalld veth-bloat check in the health table; --orphans hint
Align wiki with 0.11.1: OrbStack guide, filesystem-first UID mapping, dir-pool health warning, idempotent context injection, version-fix note
- macOS Setup Guide: OrbStack is now a first-class documented option
(setup steps, how COI handles the FUSE-backed macOS share via
raw.idmap, the OrbStack >=2.2.2 silent-breakage background, storage
notes); 'How It Works' rewritten around the v0.11.1 filesystem check
with the reactive fallback; Manual Override reframed as rarely
needed; Colima instructions now install Incus from Zabbly (Ubuntu's
6.0 is below the required 6.1).
- Configuration/Architecture/File-Transfer/FAQ pages: UID-mapping
mechanism descriptions updated (auto-selected shift vs raw.idmap),
disable_shift comment rewritten, Colima-only framing widened to
Colima/Lima/OrbStack.
- System Health Check/Troubleshooting/Best Practices/Getting Started/
Linux Setup Guide: dir-pool driver warning documented (detection,
cost, fix), example output shows the new 'pool (driver)' label,
manual-setup example no longer recommends a dir pool, Zabbly note
reframed around the automatic raw.idmap recovery, #673 version/update
known-issue note added.
- Troubleshooting/Supported-Tools/Profiles: idempotent marker-delimited
sandbox-context injection documented incl. auto-healing of bloated
files; tool interface snippets synced (AlwaysSetupConfig, full effort
level list).
- nftables internals: NFT monitoring is disabled by default.
- Nav (Home/Sidebar/Footer): 0.10.1->0.11.0 migration links; FAQ count
fix; IPv6 host-side blocking wording.
Post-release audit: fix ~50 inaccuracies vs v0.10.0 behavior
Triple-check audit of every page against the released binary and code.
Systemic: firewalld -> nftables (stale since the v0.9 #405 migration) across
Network-Isolation, Linux-Setup-Guide, Architecture-and-Security-Model,
Getting-Started, Home, FAQ*, Best-Practices, Troubleshooting,
System-Health-Check — including the whole 'Firewalld Setup' section that
told users to create the wrong sudoers file (/etc/sudoers.d/coi-firewalld);
now documents nftables + /etc/sudoers.d/coi-nft (matching install.sh), the
real error string, use_sudo=false, and the real orphan classes and health
check names. Distro-default-firewall tips (Fedora/openSUSE) kept but
decoupled from COI's own mechanism.
Audit-Log: JSONL examples and field reference rewritten to the real
ThreatEvent shape (id/timestamp/level/category/title/description/evidence/
action — the old examples used fields that never existed); COI_AUDIT_*
tuning corrected (host env is not forwarded; use incus config set).
Security-Best-Practices: default protected-paths table matches the 0.10
set; protection-weakening keys documented as trusted-scope only (untrusted
project configs are sanitized); #533 linked-worktree support and #556 git
identity seeding documented.
Command usage: coi update core --check (not coi update --check), coi info
<session-id>, coi persist <container>, coi run's interactive build prompt,
stop-before-publish in the image workflow, --slot pinning.
Config accuracy: memory enforce default is soft; effort_level accepts
low/medium/high/xhigh/max/auto (default unset); [limits.disk] values are
I/O rates not storage caps (Best-Practices example fixed); protected_paths
default list completed; threat levels are INFO/WARNING/HIGH/CRITICAL.
Navigation: 0.9->0.10 migration section linked from Home, sidebar, and
footer; broken FAQ prompt-injection anchor retargeted.
docs: complete structural, content, and style improvements (S4-S6, C1-C5, F5)
Structural:
- S4: Add Slot System section to Container-Lifecycle-and-Sessions explaining
container naming, auto-allocation, per-slot isolation, and alias suffixes
- S5: Merge Self-Update into System-Health-Check (update commands, how-it-works,
post-update steps); Self-Update.md becomes a redirect
- S6: Add Migration-Guide.md covering .coi.toml → .coi/config.toml move and
[[mounts]] vs [[mounts.default]] syntax difference
Content:
- C1: Add Best-Practices.md covering session mode selection, network mode
guide, monitoring recommendations, long-running tasks, team workflows,
AI-generated code handling, and storage cleanup
- C2: Expand Snapshot-Management.md with context opener (stateless vs stateful
tradeoffs, restore requirement) and Best Practices section
- C3: Add Troubleshooting section to Image-Management.md (image not found,
build failures, wrong image applied, stale image after update) and
Best Practices section
- C4: Document coi run in Container-Operations.md with use cases, flags,
and differences from coi shell
- C5: Add JSONL field schema tables to Security-Monitoring.md (common fields,
type-specific fields, NFT-specific fields)
Formatting:
- F5: Add Best Practices sections to Network-Isolation, Profiles,
Image-Management, and Snapshot-Management
Navigation:
- Home.md updated with Best-Practices and Migration-Guide in nav
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
docs: replace em dashes with hyphens across all wiki pages
Docs audit for 0.8.0: fix [defaults] → [container], coi resume → coi unfreeze, add security features
- Fix [defaults] → [container] for image/persistent in Configuration.md, Image-Management.md
- Replace all coi resume → coi unfreeze references (Security-Monitoring, Troubleshooting, Lifecycle)
- Add host-side immutable protection and guest API sections to Security-Best-Practices.md
- Add container aliases section to Container-Lifecycle-and-Sessions.md
- Update System-Health-Check.md for multi-pool support
- Add host_immutable, alias, storage_pool to config reference
Update wiki for 0.8.0 release
- Rename default image coi → coi-default
- Move config path ~/.config/coi/config.toml → ~/.coi/config.toml
- Drop /etc/coi/ and ~/.config/coi/ from config hierarchy
- Replace coi build custom with profile-based build workflow
- Rename coi profile show → coi profile info
- Document profile inheritance (inherits field)
- Document coi profile create/edit/delete commands
- Remove non-existent coi config --init reference
Update wiki for 0.8.0 unreleased changes
System-Health-Check.md:
- Rewrite example output with all 27 current checks
- Expand "What's Checked" table with all categories and checks
- Add Security Posture Details section (status logic table)
- Add Version Checks section (Incus >= 6.1, nftables >= 0.9.0, kernel >= 5.15)
- Add JSON output example with security_posture details
- Update notes for Colima/Lima and privileged profile detection
Security-Best-Practices.md:
- Add privileged container guard, security posture verification, and
kernel version enforcement to defense-in-depth summary (8 → 11 layers)
Troubleshooting.md:
- Add "COI refuses to start: security.privileged=true" entry with fix
- Add "Kernel version warning on startup" entry
FAQ.md:
- Fix [container] → [paths] for preserve_workspace_path config
docs: update wiki for recent security monitoring features
Security-Monitoring.md:
- Add large write detection for data exfiltration
- Add disk space monitoring (/tmp > 80% warning)
- Add coi resume command documentation
- Add threat deduplication (30-second window)
- Add complete configuration options
- Add threat level table with severities
- Add example for detecting data exfiltration
- Add NFT cleanup troubleshooting
Supported-Tools.md:
- Update opencode resume behavior (--continue flag)
- Add permission bypass row to comparison table
System-Health-Check.md:
- Clarify Incus storage pool thresholds
Troubleshooting.md:
- Add section for container paused by monitoring
- Add section for container killed by monitoring
- Document coi resume workflow
FAQ.md:
- Add real-time threat detection to protection list
- Add monitoring best practices
docs: add Security Monitoring and Supported Tools pages, update health checks
- Add Security-Monitoring.md: real-time threat detection, nftables monitoring,
automated response, audit logging
- Add Supported-Tools.md: Claude Code vs opencode comparison, tool selection,
API key configuration, adding new tools
- Update System-Health-Check.md: add Incus storage pool, monitoring checks,
container networking checks
- Update Security-Best-Practices.md: reference new Security Monitoring page
- Update Home.md: add links to new pages
Add System Health Check guide