generating-swift-package-docs

Name: generating-swift-package-docs
Author: johnrogers

222stars19forks

How to install generating-swift-package-docs?

johnrogers/claude-swift-engineering/generating-swift-package-docs

$npx -y skills add johnrogers/claude-swift-engineering --skill generating-swift-package-docs

Installs into the current project.

Summary

Use when encountering unfamiliar import statements, exploring dependency APIs, or when user asks "what's import X" or "what does X do". Generates on-demand API documentation for Swift package dependencies.

Files · 1

View on GitHub

SKILL.md

1	# Swift Package Documentation Generator
2
3	Generates API documentation for Swift package dependencies on-demand, extracting symbol information from Xcode's DerivedData to answer "what does this library do?"
4
5	## Overview
6
7	When exploring unfamiliar dependencies, generate their documentation automatically instead of guessing from code. This tool uses `interfazzle` to extract symbol information from compiled modules.
8
9	## How to Use
10
11	When asked about an unfamiliar Swift module import:
12
13	1. Run: `./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>"`
14	2. Script outputs path to cached documentation file
15	3. Read the file and provide relevant information
16
17	Prerequisites: Project must be built once (DerivedData exists), `interfazzle` CLI installed.
18
19	See [reference.md](reference.md) for error handling and details.

People who liked this also viewed

6 picks

Type