apple-docs-index

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Apple Documentation Index

Apple文档索引

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

本技能提供苹果框架文档的索引内容，可用于：

浏览框架中可用的API
查找特定文档的路径
确定需要下载的详细文档内容

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
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

框架	文件	大小	主题
SwiftUI	`../swiftui/swiftui-overview.md`	907KB	视图、修饰符、导航、状态
XCTest	`xctest-index.md`	55KB	测试、断言、期望
XCUIAutomation	`xcuiautomation-index.md`	58KB	UI测试、元素、查询
UIKit	`../uikit/uikit-overview.md`	1.8MB	视图、控制器、控件、场景
HealthKit	`healthkit-index.md`	312KB	健康数据、运动、记录
Combine	`combine-index.md`	153KB	发布者、订阅者、操作符
SwiftData	`swiftdata-index.md`	86KB	模型、容器、查询
Observation	`observation-index.md`	3KB	@Observable 宏

How to Use

使用方法

1. Browse an Index

1. 浏览索引

bash

undefined

bash

undefined

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

undefined

grep -i "workout" healthkit-index.md grep -i "navigation" ../swiftui/swiftui-overview.md

undefined

2. Find Documentation Paths

2. 查找文档路径

Index files list all available documentation pages. Each entry shows the path:

markdown

- [HKWorkout](/documentation/healthkit/hkworkout)
- [NavigationStack](/documentation/swiftui/navigationstack)

索引文件列出了所有可用的文档页面，每个条目都会显示路径：

markdown

- [HKWorkout](/documentation/healthkit/hkworkout)
- [NavigationStack](/documentation/swiftui/navigationstack)

3. Fetch More Detailed Docs

3. 获取更详细的文档

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

首先检查你已安装的Apple技能中是否已经存在该详细页面。
在获取新文档前，可使用技能名称、描述或
```
SKILL.md
```
的前置元数据查找可能的技能目录，然后检索本地的
```
.md
```
文件。这种方式比从互联网获取新文档速度更快，占用的上下文也更少。
如果已安装的技能中没有对应页面，可以将路径拼接在
```
sosumi.ai
```
Markdown镜像地址后使用。

例如，

/documentation/healthkit/hkworkout

对应的地址是

https://sosumi.ai/documentation/healthkit/hkworkout

。

4. Browse Missing Framework Indexes

4. 浏览缺失的框架索引

If the local indexes don't include the framework you need, use the framework's

sosumi.ai

index:

text

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:

text

https://developer.apple.com/tutorials/data/index/{framework}

The useful path tree is under

interfaceLanguages.swift[0].children

如果本地索引没有包含你需要的框架，可以使用

sosumi.ai

上对应框架的索引：

text

https://sosumi.ai/documentation/{framework}

例如，

https://sosumi.ai/documentation/foundation

提供了可搜索的Foundation框架路径的Markdown索引。

如果Markdown镜像无法访问，且你的环境支持解析JSON，可以使用苹果公开的DocC索引端点：

text

https://developer.apple.com/tutorials/data/index/{framework}

可用的路径树位于

interfaceLanguages.swift[0].children

节点下。