Skip to content

docs(0201): slim README + site-canonical cleanup + 5-behavior docs [yw]#355

Merged
clkao merged 3 commits into
mainfrom
spacedock-ensign/readme-and-docs-architecture-cleanup
Jun 13, 2026
Merged

docs(0201): slim README + site-canonical cleanup + 5-behavior docs [yw]#355
clkao merged 3 commits into
mainfrom
spacedock-ensign/readme-and-docs-architecture-cleanup

Conversation

@clkao

@clkao clkao commented Jun 13, 2026

Copy link
Copy Markdown
Collaborator

Final member of 0201 — the sole doc surface for the sprint.

  • Slim README to a thin front door: drop Quick start / How it works / Usage; add the full-docs link to spacedock.md/docs; keep install + build/test + License + Contributing.
  • Remove the banned prose-grep test (internal/release/install_doc_test.go); install-journey.md is already gone on main, grep-clean.
  • Document the five behaviors on canonical site pages: gj --version (version-forward, plain words), te upgrade-hint (Setup), zrc launch posture (Launch), gp marketplace decouple (releasing.md + build-from-source.md edge channel), 8p agentsview (install.md Homebrew tab).
  • --version doc rewritten to match da (fix(0201): show per-runtime plugin version in --version, drop enablement jargon [da] #354): version-forward, no enablement jargon.

Validation PASSED + an adversarial doc-vs-shipped-code fidelity audit (6 skeptics; every behavior faithful). Docs-only + the test removal; zero production code. Whole-repo go test green (1318/16). Rebased onto current main (after #353 + #354).

🤖 Generated with Claude Code

clkao and others added 3 commits June 13, 2026 12:13
Wave 1 structural cleanup for the site-is-canonical doc architecture:

- Remove internal/release/install_doc_test.go — a banned prose-grep that
  os.ReadFile'd docs/site/get-started/install.md and asserted author
  substrings. readInstallJourney was file-local; executableShellCommands
  stays (defined in workflow_exec_guard_test.go, 9 other call sites).
- Slim README.md to the front-door skeleton: keep title + Why hook,
  What's different, Install, License, Contributing. Drop Quick start,
  How it works, Usage (now on the canonical site).
- Install now links the published site https://spacedock.md/docs/
  (site_url in mkdocs.yml), keeping the in-repo install.md as secondary.

go test ./... green; install-journey grep-clean over live docs/code.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Wave 2 behavior-doc pass — yw is the sole doc-owner; the five members
shipped zero .md. Each behavior documented on its reverified anchor:

- gj (#350): new `## --version` section in command-reference.md showing
  the version+contract line, the Sandbox: posture, and the per-runtime
  install/enablement block (wording exercised from `spacedock --version`).
- te (#351): command-reference `## Setup` names the contract-compatible-
  but-behind opt-in upgrade hint (doctor + front-door print it; never blocks).
- zrc (#349): command-reference `## Launch` names the unsandboxed posture —
  claude `--permission-mode auto`, codex `--ask-for-approval on-request`,
  vs the sandboxed skip/bypass. Scoped to claude/codex; pi injects none.
- gp (#352): releasing.md made decouple-accurate — marketplace manifest
  moved to the standalone spacedock-dev/marketplace repo, no plugin-branch
  manifest, marketplace.json dropped from the release steps; build-from-
  source.md adds a spacedock-edge edge-channel user pointer.
- 8p (#347): install.md Homebrew tab notes brew also installs agentsview;
  safehouse is installed separately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… [yw]

#354 (da) replaced the enablement-jargon per-runtime block with a
version-forward one. Rewrite the `## --version` section to match:

- `<host>: spacedock <version>` when a plugin is installed
- ` (disabled)` appended only when the host reports it disabled
- `pi: spacedock ready` (pi launches from skills, no versioned plugin)
- `<host>: spacedock not installed` when host present but no plugin
- `<host>: not installed` when the host binary is absent

Drops the obsolete "installed, spacedock enabled" / "enablement unknown"
phrasing. Wording read from runtimeLine in internal/cli/host_runtime.go;
example output built and exercised via `go build && ./spacedock --version`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@clkao clkao merged commit 895c21d into main Jun 13, 2026
6 of 9 checks passed
clkao added a commit that referenced this pull request Jun 13, 2026
… merged to main

Last 0201 member. Slim README + site-canonical cleanup + the 5 behaviors documented on
canonical site pages + --version doc matched to da #354. Validation PASSED + adversarial
fidelity audit; --version-doc fold re-verified against the live binary. Docs-only; zero production code.
@clkao clkao deleted the spacedock-ensign/readme-and-docs-architecture-cleanup branch June 13, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant