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