Repository navigation
docs: launch-ready README - #26
Merged
Merged
Conversation
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
commented
Oct 11, 2026
parnexcodes
left a comment
Member
Author
There was a problem hiding this comment.
Review: docs: launch-ready README
Verdict: SHIP
Blocking
None.
Non-blocking
- Fixed on the branch (76db61c): questions now point to Discussions, and the pinned "latest v0.2.0" is gone.
- 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/workspaceswould help.
Checks
pip install git+https://github.com/usedock/dock-pythoninto a scratch venv: builds and installs.from usedock import Dock, DockErrorworks, andclient.docks.files,.ports,client.imagesandclient.connectorsexist.- The
docklet#install-the-clianchor exists on docklet main and on the PR branch. - Commands checked against
internal/cliandinternal/localat 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.activereturnslocal. Localdock newchecks the accelerator, thenCache.Ensuredownloads the image; the default isubuntu-24.04. - The pinned Dockyard index
images-2026.10.11/dockyard.jsondownloads 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
internal/cliin 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-inlocal(Config.active).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}.Risk
Docs only; no code changes. The recording is a marked placeholder for the owner.
🤖 Generated with Claude Code