apple-docs-index
Skill336 starsChanged 7 months agoMITView on GitHub
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.
In this repository29 other files it gives its agents.
- AGENTS.mdAGENTS.md
- apple-asoSkill
- backgroundtasksSkill
- combineSkill
- core-animationSkill
- corehapticsSkill
- eventkitSkill
- guide-macos-spm-packagingSkill
- guide-swift-concurrencySkill
- guide-swiftdataSkill
- guide-swift-testingSkill
- guide-swiftui-chartsSkill
- guide-swiftui-performance-auditSkill
- healthkitSkill
- higSkill
- ios-devSkill
- ios-liquid-glassSkill
- mapkitSkill
- photosuiSkill
- storekitSkill
- swift-concurrencySkill
- swiftdataSkill
- swift-testingSkill
- swiftuiSkill
- tipkitSkill
- uikitSkill
- usernotificationsSkill
- widgetkitSkill
- xcuitestSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 52
Check whether the detailed page is already available in one of your installed Apple skills.
- Very specific: line 53
Use skill names, descriptions, or SKILL.md frontmatter to find likely skill directories, then grep their local .md files before fetching.
- Very specific: line 54
If no installed skill has the page, use the same path with the sosumi.ai Markdown mirror.
- Very specific: line 60
If the local indexes don't include the framework you need, use the framework's sosumi.ai index:
- Distinctive: line 68
If the Markdown mirror is unavailable and your environment can parse JSON, Apple's public DocC index endpoint is:
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
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.md2. 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.mdfrontmatter to find likely skill directories, then grep their local.mdfiles 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.aiMarkdown 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.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

