Skip to content

Document the dual-binary requirement on the GitHub Release page (close the docs gap from #258) #265

@Hmbown

Description

@Hmbown

Problem

@whereiszebra (#258) closed their own issue with feedback that's worth acting on directly:

Release page does not document that both deepseek-macos-arm64 and deepseek-tui-macos-arm64 must be downloaded together.

We addressed the error message in v0.8.3 (bb88ab91) and queued a meta-crate solution (#264). This issue tracks the docs side: make the GitHub Release page itself say what to download.

Concrete change

In .github/workflows/release.yml, the softprops/action-gh-release@v1 step uploads files but uses the default release notes (auto-generated from commit titles). Add a body: field with prebuilt text that explains:

  1. Recommended: npm install -g deepseek-tui (one command, both binaries)
  2. Alternative: cargo install deepseek --locked (after Cargo meta-crate deepseek so cargo install deepseek ships both binaries (resolves #258 root cause) #264 ships)
  3. Manual download: download BOTH deepseek-<platform> AND deepseek-tui-<platform> for your OS+arch, place them in the same directory, chmod +x both, run ./deepseek.
  4. Verify: sha256sum -c deepseek-artifacts-sha256.txt (or shasum -a 256 -c on macOS)

A short table of what each artifact is would also help.

Acceptance criteria

  • Release workflow includes a body: template that explains the dual-binary requirement
  • Template references the SHA256 verification step
  • First release that runs the updated workflow has the documented body visible on the Release page

Why this is a good first issue

Self-contained YAML edit + a short markdown template. No Rust knowledge needed. Test by running gh workflow run release.yml --ref v0.8.4 -f version=0.8.4-test (against a non-production tag) once a draft of the body is written.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions