richardcase / richardcase/clowder
Correct stale release and Swift build documentation
Nobody has claimed this yet.
- 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:
- https://github.com/richardcase/clowder/blob/b5492d5/README.md#L123-L161
- https://github.com/richardcase/clowder/blob/b5492d5/docs/code-signing.md#L143-L153
- https://github.com/richardcase/clowder/blob/b5492d5/docs/homebrew.md#L36-L50
- https://github.com/richardcase/clowder/blob/b5492d5/AGENTS.md#L48-L58 and #L191-L195
Acceptance criteria
- Make
docs/versioning.mdthe 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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