Files

T

Jon Chery 0ca19696b1 docs(P00): ideate — 8 ideas accepted (REQ-091..098), ROADMAP renumbered

---ci---
project: orca
phase: 0
milestone: v0.10
status: ideate
---/ci---

2026-08-05 20:47:10 +00:00

Ideation: v0.10 Docs & Install Milestone

Tier 1 — Mechanical (codebase-grounded, no new deps)

ID	Idea	Source	Accepted	REQ
I-M-091	`docs/cli.md` comprehensive CLI reference	README subcommand table is stale (missing cert/daemon/doctor/audit/ns/node-capacity/node-key-reset); no `docs/` CLI reference exists	✅	REQ-091
I-M-092	`docs/jobspec.md` markdown frontmatter schema reference	Operators must read `internal/jobspec/markdown.go` source to author jobspecs; no reference doc exists	✅	REQ-092
I-M-093	`docs/ingress.md` Traefik ingress reference	The service→Traefik mapping (R-007, atomic reload, drain, TLS) is undocumented; the user explicitly asked for "ingress configured"	✅	REQ-093
I-M-094	`examples/full-stack/` with 5 valid jobspecs + rendered artifacts + walkthrough	No examples directory exists; `testdata/` holds legacy HCL test fixtures, not operator examples	✅	REQ-094
I-M-095	README.md refresh (status, subcommand table, install example, dev targets, docs/examples sections)	README says "v0.1: Foundation"; subcommand table missing 5 commands; install example pins v0.4.2	✅	REQ-095
I-M-096	`docs/namespace.md` v0.9 multi-namespace layout update	Documents the v0.8 flat layout, not the v0.9 `cluster/`+`_defaults/`+per-ns layout	✅	REQ-096

ID	Idea	Source	Accepted	REQ
I-B-097	`scripts/release.sh` cross-build amd64 + post-create asset verification	v0.8.x releases shipped with zero binary assets; install.sh resolves to v0.8.15 then errors on missing tarball; root cause of v0.4.5 install	✅	REQ-097
I-B-098	`scripts/install.sh` asset fallback walk + `--check` dry-run	install.sh has no fallback when the latest release lacks the expected tarball; a broken release blocks all installs	✅	REQ-098

No cross-project ideas. Orca is single-project mode.

Backfill the existing v0.8.15 release with a binary asset — rejected per D-192. Backfilling a past release is an ops task, not a docs milestone deliverable. The next tagged phase (P1 ship at v0.9.1) will be the first correctly-asseted release; install.sh's fallback walk handles the gap.
Document both v0.8 and v0.9 paths equally — rejected per D-191. The v0.8 path is deprecated and scheduled for removal; documenting it as primary misleads new operators.
arm64 tarball in release.sh — rejected for this milestone per D-193. The install user base is amd64 today; arm64 is a separate enhancement.
Per-command docs/cli/*.md subdirectory — rejected per D-188. Single-file docs/cli.md matches the existing flat docs/ layout.