Skip to content

READMEs and the migration guide #62

Closed

Description

@Fly-Playgroud

Parent

Spec: #33 (Baseline release). Section numbers refer to its Implementation Decisions.

What to build

A go-rod user reads one page and knows exactly what to change and what still does not work; a newcomer reads the README in English or Chinese and knows what wand is, where it runs, which Chrome it targets and how to trust it. Spec section 18; ticket #15, #18, #32.

Acceptance criteria

  • English and Chinese READMEs: the lineage paragraph (two lines linking go-rod's repository and NOTICE, one sentence linking the migration guide, no link to any Release); a Roadmap section (the baseline, then API modernization and Stealth as planned, no dates); the Scorecard badge; the image verification line; a link to versions.json; the Support tier table and the Support window; the Go floor with the Domestic platform build paths (system Go on openEuler 24.03, cross-compile or tarball elsewhere, new-world loong64 only); a Browser resolution summary with the environment variables and the known domestic browser paths; install and quick start on the new module path; container image usage.
  • docs/migrating-from-go-rod.md: the import prefix swap; gson to lazyjson; the removed assets package and seven utils helpers; the two cmd/ commands; the browser cache location; leakless to Orphan guard and the Leakless() semantics; User mode's profile directory; -rod= to -wand= and WAND_BROWSER_*; the second ErrCtxDestroyed message; the container image rename and multi-arch tag; a Known limitations section listing omitempty booleans, OOPIF Element.Frame() / ControlURL(), Ubuntu 24.04 NoSandbox, Alpine Chromium, no managed download on windows/arm64, loong64 and musl, and new-Headless semantics.
  • Package READMEs consistent with the above; no dead links.

Blocked by

Activity

  1. Fly-Playgroud commented on Sep 7, 2026

    @Fly-Playgroud
    ContributorAuthor

    The Scorecard badge markdown, for both READMEs, from #56 (PR #92). Scorecard publishes to the OpenSSF API weekly and on every push to main, so the badge is live from the first run on main:

    [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/headlesslab/wand/badge)](https://scorecard.dev/viewer/?uri=github.com/headlesslab/wand)

    It is also recorded in docs/maintainer-notes.md, under "The security Gates, Dependabot and Scorecard". The Chinese README carries the same markdown; the badge image and the viewer page are language-neutral.

  2. added a commit that references this issue on Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-agentFully specified, ready for an AFK agent

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions