Repository navigation
docs: link the DocC documentation from the README - #28
Merged
Merged
Conversation
This was referenced Oct 18, 2026
TUNER88
added a commit
that referenced
this pull request
Nov 1, 2026
…e is optional (#32) 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 #26 and #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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds one new line to the intro bullets of the README, linking to the DocC site on GitHub Pages. It's based on
masterand not stacked.The site goes live when #27 is merged and its first deploy runs, so merge this PR after #27. Until then the URL returns 404. That's why
.lycheeignoreexcludes exactly this one URL from the link check, with a comment explaining why. It can be removed once the site is live.Nothing existing changes: 0 removed or changed lines, all anchors are present, and the must-not-break check passes. It also merges cleanly with #26.