Skip to content

docs: link the DocC documentation from the README - #28

Merged
TUNER88 merged 3 commits into
masterfrom
docs/readme-docs-link
Oct 18, 2026
Merged

TUNER88 merged 3 commits into
masterfrom
docs/readme-docs-link

Conversation

@TUNER88

@TUNER88 TUNER88 commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

This adds one new line to the intro bullets of the README, linking to the DocC site on GitHub Pages. It's based on master and 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 .lycheeignore excludes 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.

@TUNER88
TUNER88 merged commit ece9897 into master Oct 18, 2026
12 checks passed
@TUNER88
TUNER88 deleted the docs/readme-docs-link branch October 18, 2026 20:14
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.
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