Copilot-Skills apple-docs.instructions.md

Apple Docs - Auto-Loaded Instructions

Auto-loads for: **/*.swift, **/*.swiftui, **/Package.swift

Default Behaviors

When working in Swift files, this skill provides:

• Quick access to Apple's official API documentation
• Symbol lookup for Swift/SwiftUI components
• Framework exploration capabilities

Common Patterns

Looking Up Swift Symbols

When you see unfamiliar Swift code:

let task = Task { ... }

Use: bash .github/copilot-skills/documentation/apple-docs/scripts/get-symbol.sh swift/task

Finding SwiftUI Components

When building UI:

Button("Press Me") { ... }

Use: bash .github/copilot-skills/documentation/apple-docs/scripts/get-symbol.sh swiftui/button

Exploring Frameworks

When starting a new feature, explore available APIs:

bash .github/copilot-skills/documentation/apple-docs/scripts/search-framework.sh swiftui "navigation"

Quality Guidelines

Code Style

• Follow Swift naming conventions (PascalCase for types, camelCase for variables)
• Use descriptive names that match Apple's API patterns
• Leverage type inference where appropriate

SwiftUI Patterns

• Use declarative view composition
• Prefer built-in modifiers over custom solutions
• Check documentation for availability across platforms

Documentation References

• Always check symbol availability for target platforms
• Reference Apple docs when using advanced APIs
• Link to specific symbols in code comments when helpful

Workflow Integration

During Development

1. Encounter unfamiliar API
2. Run get-symbol.sh to fetch docs
3. Review usage and examples
4. Implement correctly

Code Review

1. Question API usage
2. Verify with search-framework.sh
3. Check platform availability
4. Suggest alternatives if needed

Best Practices

✅ Do:

• Use scripts to verify API availability
• Check documentation before Stack Overflow
• Search frameworks before creating custom solutions
• Cache frequently used documentation locally