API reference (DocC)
This site hosts the narrative documentation: getting started, guides, concepts. It does not include the auto-generated method-by-method reference.
The complete API reference — every public type, every method signature, every doc comment — is generated with DocC directly from the SwiftSonic source and published separately.
Where to find it
Section titled “Where to find it”TODO: link the DocC reference URL once the publishing pipeline is set up on the SwiftSonic repo. Likely candidates:
https://mathieudubart.github.io/SwiftSonic/documentation/swiftsonic/- or a subpath of this site at
/api/.
Until then, browse the source on GitHub: github.com/MathieuDubart/SwiftSonic.
Why split narrative from reference
Section titled “Why split narrative from reference”Narrative docs explain why and how to think about the library. Reference docs are exhaustive and machine-generated. Mixing them muddles both. Keeping them apart means:
- The narrative stays small and curated — no auto-generated noise.
- The reference stays current — every release regenerates it from doc comments.
- Improvements to either side don’t require touching the other.
If you find a doc comment in the source that’s wrong or missing, fix it there and the reference updates with the next release.