Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: lead Quick start with forkd pull, plus v0.3.4 / doctor-screenshot polish#165

Merged
WaylandYang merged 3 commits into
mainfrom
docs/quickstart-lead-with-hub
May 27, 2026
Merged

docs: lead Quick start with forkd pull, plus v0.3.4 / doctor-screenshot polish#165
WaylandYang merged 3 commits into
mainfrom
docs/quickstart-lead-with-hub

Conversation

@WaylandYang

Copy link
Copy Markdown
Contributor

Summary

Closes the open M1.2 ROADMAP item "README quickstart rewritten to lead with forkd pull" and folds in two hygiene-grade docs commits that had been sitting on dev.

What changed

Three commits, all docs:

  • f13de9c docs: audit sweep — sync stale v0.3.1/v0.3.2 refs to v0.3.4 — sweeps version strings across docs to match the current release.
  • a4afa41 docs: embed forkd doctor screenshot (14 checks pass) into repo — inlines the doctor screenshot into the install section.
  • 6cf8ab4 docs: lead Quick start with forkd pull recipe path — the M1.2 wrap:
    • English README: rename "Fastest path — pull a pre-built snapshot from the Hub""Run your first fork (recommended)" so it reads as the default path, not as an option. The trailing two sections are reframed as "Alternative: build from a Docker image" and "Alternative: build from source (advanced)".
    • Chinese README: previously omitted the Hub flow entirely — adds a new "二. 第一次 fork(推荐)" section with the parallel forkd pull deeplethe/langgraph-react snippet and renumbers the trailing sections.
    • One-line Quick-start intro added in both languages framing the structure: two-step happy path, alternatives below.

End-to-end verification

$ forkd pull deeplethe/langgraph-react
→ resolving via https://raw.githubusercontent.com/deeplethe/forkd/main/registry.json
==> GET https://github.com/deeplethe/forkd/releases/download/hub-langgraph-react-v1/langgraph-react.forkd-snapshot.tar.zst
✓ downloaded 14.5 MiB (15 s)
✓ sha256 verified (96dae77acc588da6)
✓ unpacked tag 'langgraph' at /home/yangdongxu/.local/share/forkd/snapshots/langgraph

Same recipe, English README quickstart, copy-paste from a clean shell on the dev box.

Out of scope

  • Filling out the Hub catalog with the other 14 recipes (mcp-agent, crewai-fanout, python-numpy, etc.) — those need fresh snapshot builds and are deferred to a follow-up PR. Today the Hub serves deeplethe/langgraph-react and deeplethe/coding-agent-fork; that's enough to make the forkd pull quickstart path real.

WaylandYang and others added 3 commits May 26, 2026 02:40
Stale-content sweep after v0.3.4 ship + 4 v0.4 PoCs landed:

- ROADMAP.md: bump 'Current release' from v0.3.1 to v0.3.4; add v0.4
  RFC pointer; fix 'v0.2.x retro' → 'v0.4 retro' in speculative
  section.
- README.md: '3 PoCs' → '4 PoCs' (Phase 4 restore PoC landed);
  extend phase-1 ship range to v0.3.0 → v0.3.4 with the multi-BRANCH
  fix note.
- README-zh.md: mirror the EN updates — port the missing
  'filesystem state, not just reasoning' section, refresh the
  v0.3.0 → v0.3.4 ship line, sync the recipes list to include
  jupyter-kernel / playwright-browser / postgres-fixture.
- INTEGRATION-BOXLITE.md: extend ship range to v0.3.4, replace stale
  '14× aggregate' callout with the v0.3.4 17.6×/8.5× multi-BRANCH
  numbers + posix_fallocate fix narrative.
- RESULTS-v0.3.md: embed v0.3.4-before-after.png chart alongside the
  10-BRANCH numbers table.
- Remove orphan docs/assets/wp-bench-demo.tape (vhs pivot to
  asciinema, .tape no longer used).

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Previously this lived on imgur and was only referenced from outside
the repo (HN post, etc.). Pulling it in-repo so:
- README has a concrete visual for what 'forkd doctor passes' means
- the screenshot survives independently of any third-party host
- WebP keeps the asset small (82 KB vs 178 KB JPEG)

Captured on the dev box: Linux 6.14, FC v1.12.0, 134 snapshots,
636 GiB free in the snapshot dir, daemon reachable on 127.0.0.1:8889.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Promote the Hub pull flow from "Fastest path — alternative section" to
the recommended first-fork experience in both README.md and README-zh.md.
The other quickstart sections (from-image, from-source) are reframed
as alternatives for users who need custom recipes.

The Chinese README previously omitted the Hub flow entirely; this PR
adds the parallel `forkd pull deeplethe/langgraph-react` section and
renumbers the trailing sections accordingly.

End-to-end verified on the dev box: `forkd pull deeplethe/langgraph-react`
downloads the 14.5 MiB pack in ~15 s, sha256 verifies, unpacks at tag
`langgraph` ready for `forkd fork --tag langgraph -n 3`.

Closes the M1.2 ROADMAP item "README quickstart rewritten to lead with
`forkd pull`".
@WaylandYang WaylandYang merged commit 5500678 into main May 27, 2026
2 checks passed
@WaylandYang WaylandYang deleted the docs/quickstart-lead-with-hub branch May 27, 2026 04:34
WaylandYang added a commit that referenced this pull request May 27, 2026
…h pull (#173)

ROADMAP M1.2 done-when items all flipped to ✓:

- Hosting decided as GitHub Releases (not R2/S3 — free, free egress,
  stable URLs, no infra to operate). Dropped the
  forkd-hub.deeplethe.com custom-domain plan as unnecessary.

- 9 snapshot-producing recipes published: python-numpy,
  playwright-browser, postgres-fixture, coding-agent, nodejs,
  e2b-codeinterpreter, jupyter-kernel, langgraph-react,
  coding-agent-fork. agent-workbench remains for follow-up (its
  ghcr.io base image pull is rate-limit-sensitive).

- README quickstart already leads with `forkd pull` (shipped #165
  this week, both en/zh).

docs/HUB.md "What's currently published" table expanded from 2 to
9 entries, the "more recipes will land" disclaimer removed.
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