richardcase / richardcase/clowder

Correct stale release and Swift build documentation

Open Beginner friendly
#143 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation priority: medium
Dominant language
Rust
Stars
0
Forks
0
Avg merge
1h 14m
Merged PRs (30d)
16

Description

Problem

Public documentation describes tag-triggered/manual-tag releases even though the workflow is manual-dispatch-only and creates tags itself. It also documents the wrong DMG filename and contradicts itself about whether swift test needs the vendored libghostty archive.

Evidence:

Acceptance criteria

  • Make docs/versioning.md the canonical release procedure.
  • Correct DMG names and dispatch instructions.
  • Document archive-free Swift target builds separately from full swift test.
  • Remove contradictory instructions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare docs/versioning.md with the release and build guidance in README.md, docs/code-signing.md, docs/homebrew.md, and AGENTS.md, using the cited sections as the starting point. Update the documents so docs/versioning.md is canonical, DMG names and dispatch instructions agree, archive-free Swift target builds are distinct from full swift test, and no contradictions remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.