Apple Documentation Index
This skill provides indexes of Apple framework documentation. Use these to:
- Browse available APIs in a framework
- Find the path to specific documentation
- Decide what detailed docs to download
Available Indexes
| Framework |
File |
Size |
Topics |
| SwiftUI |
../swiftui/swiftui-overview.md |
907KB |
Views, modifiers, navigation, state |
| XCTest |
xctest-index.md |
55KB |
Testing, assertions, expectations |
| XCUIAutomation |
xcuiautomation-index.md |
58KB |
UI testing, elements, queries |
| UIKit |
../uikit/uikit-overview.md |
1.8MB |
Views, controllers, controls, scenes |
| Core Animation |
../core-animation/core-animation-index.md |
80KB |
CALayer, CAAnimation, CATransaction, layer subclasses |
| HealthKit |
healthkit-index.md |
312KB |
Health data, workouts, records |
| Combine |
combine-index.md |
153KB |
Publishers, subscribers, operators |
| SwiftData |
swiftdata-index.md |
86KB |
Models, containers, queries |
| Observation |
observation-index.md |
3KB |
@Observable macro |
How to Use
1. Browse an Index
# See what's in HealthKit
cat healthkit-index.md | head -100
# Search for specific topic
grep -i "workout" healthkit-index.md
grep -i "navigation" ../swiftui/swiftui-overview.md
2. Find Documentation Paths
Index files list all available documentation pages. Each entry shows the path:
- [HKWorkout](/documentation/healthkit/hkworkout)
- [NavigationStack](/documentation/swiftui/navigationstack)
3. Fetch More Detailed Docs
- Check whether the detailed page is already available in one of your installed Apple skills.
- Use skill names, descriptions, or
SKILL.md frontmatter to find likely skill directories, then grep their local .md files before fetching. This is faster and uses less context than fetching new docs from the internet.
- If no installed skill has the page, use the same path with the
sosumi.ai Markdown mirror.
For example, /documentation/healthkit/hkworkout maps to https://sosumi.ai/documentation/healthkit/hkworkout.
4. Browse Missing Framework Indexes
If the local indexes don't include the framework you need, use the framework's sosumi.ai index:
https://sosumi.ai/documentation/{framework}
For example, https://sosumi.ai/documentation/foundation provides a Markdown index you can search for Foundation paths.
If the Markdown mirror is unavailable and your environment can parse JSON, Apple's public DocC index endpoint is:
https://developer.apple.com/tutorials/data/index/{framework}
The useful path tree is under interfaceLanguages.swift[0].children.
1---2name: apple-docs-index3description: Index of Apple developer documentation for iOS, macOS, and related frameworks. Use when looking up what APIs exist in a framework, browsing available documentation, or deciding what docs to fetch. Covers SwiftUI, UIKit, Core Animation (QuartzCore), XCTest, HealthKit, Combine, SwiftData, and more.4---5
6# Apple Documentation Index
7
8This skill provides indexes of Apple framework documentation. Use these to:
9- Browse available APIs in a framework
10- Find the path to specific documentation
11- Decide what detailed docs to download
12
13## Available Indexes
14
15| Framework | File | Size | Topics |
16|-----------|------|------|--------|
17| SwiftUI | `../swiftui/swiftui-overview.md` | 907KB | Views, modifiers, navigation, state |
18| XCTest | `xctest-index.md` | 55KB | Testing, assertions, expectations |
19| XCUIAutomation | `xcuiautomation-index.md` | 58KB | UI testing, elements, queries |
20| UIKit | `../uikit/uikit-overview.md` | 1.8MB | Views, controllers, controls, scenes |
21| Core Animation | `../core-animation/core-animation-index.md` | 80KB | CALayer, CAAnimation, CATransaction, layer subclasses |
22| HealthKit | `healthkit-index.md` | 312KB | Health data, workouts, records |
23| Combine | `combine-index.md` | 153KB | Publishers, subscribers, operators |
24| SwiftData | `swiftdata-index.md` | 86KB | Models, containers, queries |
25| Observation | `observation-index.md` | 3KB | @Observable macro |
26
27## How to Use
28
29### 1. Browse an Index
30
31```bash
32# See what's in HealthKit
33cat healthkit-index.md | head -100
34
35# Search for specific topic
36grep -i "workout" healthkit-index.md
37grep -i "navigation" ../swiftui/swiftui-overview.md
38```
39
40### 2. Find Documentation Paths
41
42Index files list all available documentation pages. Each entry shows the path:
43
44```markdown
45- [HKWorkout](/documentation/healthkit/hkworkout)
46- [NavigationStack](/documentation/swiftui/navigationstack)
47```
48
49### 3. Fetch More Detailed Docs
50
511. Check whether the detailed page is already available in one of your installed Apple skills.
522. Use skill names, descriptions, or `SKILL.md` frontmatter to find likely skill directories, then grep their local `.md` files before fetching. This is faster and uses less context than fetching new docs from the internet.
533. If no installed skill has the page, use the same path with the `sosumi.ai` Markdown mirror.
54
55For example, `/documentation/healthkit/hkworkout` maps to `https://sosumi.ai/documentation/healthkit/hkworkout`.
56
57### 4. Browse Missing Framework Indexes
58
59If the local indexes don't include the framework you need, use the framework's `sosumi.ai` index:
60
61```text
62https://sosumi.ai/documentation/{framework}
63```
64
65For example, `https://sosumi.ai/documentation/foundation` provides a Markdown index you can search for Foundation paths.
66
67If the Markdown mirror is unavailable and your environment can parse JSON, Apple's public DocC index endpoint is:
68
69```text
70https://developer.apple.com/tutorials/data/index/{framework}
71```
72
73The useful path tree is under `interfaceLanguages.swift[0].children`.
prisma-labs-dev