Skip to content

docs: clarify stable vs nightly installer assets#214

Merged
DeadWaveWave merged 1 commit intomainfrom
docs/release-installer-asset-semantics
May 1, 2026
Merged

docs: clarify stable vs nightly installer assets#214
DeadWaveWave merged 1 commit intomainfrom
docs/release-installer-asset-semantics

Conversation

@DeadWaveWave
Copy link
Copy Markdown
Owner

💡 Change Scope

  • Small Change: Fast feedback, localized UI/logic, low-risk.
  • Large Change: New feature, cross-boundary logic, runtime-risk (persistence, IPC, lifecycle, recovery).

📝 What Does This PR Do?

Aligns the standalone installer documentation with the release behavior that landed in #213.

What changed:

  • Clarifies that every release publishes tag-pinned installer/uninstaller assets such as opencove-install-v<tag>.*.
  • Clarifies that only stable releases additionally publish the generic opencove-install.* / opencove-uninstall.* aliases.
  • Documents that releases/latest/download/... always means the latest stable release and must not be used as shorthand for a nightly release.
  • Adds explicit examples for installing or uninstalling from a specific nightly/tagged release versus using the latest stable aliases.

Updated docs:

  • README.md
  • README_ZH.md
  • docs/CLI.md
  • docs/RELEASING.md

🏗️ Large Change Spec (Required if "Large Change" is checked)

N/A. This PR is documentation-only.


✅ Delivery & Compliance Checklist

  • My code passes the ultimate gatekeeper: pnpm pre-commit is completely green.
  • I have signed the CLA if required (see CLA.md).
  • I have included new tests to lock down the behavior (or explicitly stated why it's untestable).
  • I have strictly adhered to the DEVELOPMENT.md architectural boundaries.
  • I have attached a screenshot or screen recording (if this touches the UI).
  • I have updated the documentation accordingly (if adding a feature or changing a contract).

Verification completed:

  • pnpm exec prettier --check README.md README_ZH.md docs/CLI.md docs/RELEASING.md
  • pnpm line-check:staged
  • pnpm naming-check:staged
  • pnpm secret-check:staged
  • pnpm format-check:staged
  • pnpm test:staged

Not run:

  • pnpm pre-commit (full suite not necessary for this docs-only change)
  • No new tests were added because this PR updates docs only

📸 Screenshots / Visual Evidence

N/A: documentation-only.

@DeadWaveWave DeadWaveWave merged commit f947ceb into main May 1, 2026
6 of 7 checks passed
@DeadWaveWave DeadWaveWave deleted the docs/release-installer-asset-semantics branch May 1, 2026 08:22
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