Skip to content

docs: lead with the reference and AudioToolbox snippets; Swift package is optional - #32

Merged
TUNER88 merged 1 commit into
masterfrom
docs/reference-first
Nov 1, 2026
Merged

TUNER88 merged 1 commit into
masterfrom
docs/reference-first

Conversation

@TUNER88

@TUNER88 TUNER88 commented Oct 18, 2026

Copy link
Copy Markdown
Owner

The repo is primarily a reference: SystemSoundIDs and file lists, plus copy-paste AudioToolbox snippets. This PR makes the README and DocC say so, and presents the Swift package only as an optional convenience.

README

  • Intro: the bullet advertising the package's API docs is replaced by: "The usage snippets call AudioToolbox directly. Copy and paste them; no dependency is needed."
  • Usage: the original sentence stays, and a new line follows it: "The snippets below work as is. You don't need a third-party dependency to play system sounds." Swift, SwiftUI and Objective-C snippets now come first.
  • ### Swift Package Manager: the heading text is unchanged, so the #swift-package-manager anchor still works. The section moved from the top of Usage to after Objective-C and is shortened to one sentence ("Optional, and not needed to play system sounds…"), a docs link and one snippet. The SoundBrowser pointer was removed from this section.
  • Contents: that entry moved below Objective-C, with the text "Optional: Swift package". The anchor is unchanged.
  • What changed and what didn't: the only removed lines are ones added recently in feat: automate SemVer releases with release-please (first release 2.0.0) #26 and docs: link the DocC documentation from the README #28. The ID table (125 rows) and the iOS 7.0.2 list are byte-identical, all headings and anchors are present, the must-not-break check passes (including --online), and the generated sections are up to date.

DocC

  • Landing page: the abstract now says the package is "an optional convenience layer". The overview opens with "You don't need this package to play system sounds" and the one-line AudioServicesPlaySystemSound(1003) call, then points to the README tables, and only then shows the package API.
  • Getting started: a new first section, "You may not need this package", shows the AudioToolbox one-liner. "Add the package" is now "Add the package (optional)".

Repo metadata: the description ("List of all system sounds used in iOS") doesn't emphasize the package, and there are no topics. Neither was changed.

Commit type docs:, so this doesn't trigger a release.

@TUNER88
TUNER88 merged commit 3ea70c9 into master Nov 1, 2026
11 checks passed
@TUNER88
TUNER88 deleted the docs/reference-first branch November 1, 2026 20:06
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