Skip to content

docs: launch-ready README - #26

Merged
parnexcodes merged 2 commits into
mainfrom
docs/launch-readme
Oct 11, 2026
Merged

parnexcodes merged 2 commits into
mainfrom
docs/launch-readme

Conversation

@parnexcodes

Copy link
Copy Markdown
Member

Refs usedock/dock#97

What

Adds headline, git-URL install (pip install git+https://github.com/usedock/dock-python), a quickstart pointing at the CLI for a no-account try, a recording placeholder, docs links and a status line.

Why

The launch checklist needs each public README to open with the headline, an install line, a three-command quickstart, docs links and an accurate status. Some of these READMEs were stale or lacked them.

How to verify

  • Read the README opening; the fenced blocks render.
  • Commands checked against internal/cli in usedock/docklet at v0.2.0: dock new [name], dock exec <dock> -- <cmd>, dock doctor; with no key or URL configured the active context is the built-in local (Config.active).
  • URLs checked with curl -sIL (all 200): usedock.io/install, usedock.io/install.ps1, docs.usedock.io/{quickstart,cli,local-docks,local-docks/windows,self-hosting,dockyard,connectors,sdks,api}.
  • Not verified here: running the quickstart end to end on a fresh machine (no WSL docklet tests per project rule).

Risk

Docs only; no code changes. The recording is a marked placeholder for the owner.

🤖 Generated with Claude Code

parnexcodes and others added 2 commits October 11, 2026 12:32
Refs usedock/dock#97

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@parnexcodes parnexcodes left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: docs: launch-ready README

Verdict: SHIP

Blocking

None.

Non-blocking

  1. Fixed on the branch (76db61c): questions now point to Discussions, and the pinned "latest v0.2.0" is gone.
  2. The quickstart says "run the example below with your workspace ID" but does not say where to find the ID. A pointer to the dashboard or GET /v1/workspaces would help.

Checks

  • pip install git+https://github.com/usedock/dock-python into a scratch venv: builds and installs. from usedock import Dock, DockError works, and client.docks.files, .ports, client.images and client.connectors exist.
  • The docklet#install-the-cli anchor exists on docklet main and on the PR branch.
  • Commands checked against internal/cli and internal/local at v0.2.0 and main (e9ff7de): dock new [name], dock exec <dock> -- <cmd>, dock doctor, dock context add --url, dock branch --count, --cpus/--memory/--disk/--env. With no key, URL or current context, Config.active returns local. Local dock new checks the accelerator, then Cache.Ensure downloads the image; the default is ubuntu-24.04.
  • The pinned Dockyard index images-2026.10.11/dockyard.json downloads and matches the sha256 pinned in v0.2.0 (211d6fbd...). The images are amd64 only.
  • v0.2.0 is the latest release and has dock binaries for linux/darwin/windows on amd64 and arm64. Both installers verify cosign signatures and checksums.txt.
  • curl -sIL: usedock.io/install, install.ps1, docs.usedock.io/{quickstart,cli,local-docks,local-docks/windows,self-hosting,dockyard,connectors,sdks,api}, github.com/usedock/dock/discussions and the repo links all return 200.
  • gh api markdown -f mode=gfm: fences and tables render; no stray backticks or pipes. The recording placeholder is an HTML comment in the source.
  • No emojis, no claude.ai links, no strategy text.
  • CI on the head commit: all green.

@parnexcodes
parnexcodes merged commit b72b6f1 into main Oct 11, 2026
7 checks passed
@parnexcodes
parnexcodes deleted the docs/launch-readme branch October 11, 2026 07:24
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 11, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant