explore-apple-swift-docs
Explore Apple Swift Docs
Purpose
Explore Apple and Swift documentation through one top-level entry point. scripts/run_workflow.py is the authoritative runtime path for docs source selection, fallback order, Dash follow-up planning, approval gating for Dash install actions, and structured generation guidance; it does not replace the agent's own Xcode MCP, Dash, or web-doc access methods, and this skill should point users toward the shared simplicity-first Xcode-project snippet when they need reusable Apple or Swift repo guidance.
When To Use
- Use this skill for Apple or Swift API reference lookup requests.
- Use this skill for Apple or Swift guide, tutorial, symbol, or concept search requests.
- Use this skill when the user wants local docs first, wants official docs first, or wants to compare available Apple or Swift docs sources.
- Use this skill when the user wants Dash-compatible Apple or Swift docs access, install guidance for a missing Dash docset, or generation guidance when a Dash docset is unavailable.
- Recommend
xcode-build-run-workflowwhen the user needs Apple or Swift execution, diagnostics, build, run, toolchain help, or mutation decisions inside an existing Xcode project. - Recommend
xcode-testing-workflowwhen the user needs Swift Testing, XCTest, XCUITest,.xctestplan, or test diagnosis inside an existing Xcode project. - Recommend
bootstrap-xcode-app-projectwhen the user is starting a brand new native Apple app project. - Recommend
sync-xcode-project-guidancewhen an existing Xcode app repo needsAGENTS.mdor workflow-guidance alignment rather than docs exploration.
Single-Path Workflow
- Classify the request into one docs workflow mode:
exploredash-installdash-generate
- If no mode is explicit, start at
explore. - Run
scripts/run_workflow.pywith the selected mode:explore: applies configured source order, preference handling, fallback selection, and result shapingdash-install: applies configured Dash install source priority and approval gatingdash-generate: returns structured automation-first guidance for missing Dash coverage
- If the selected mode cannot complete, hand off forward through one clear next step:
explore -> dash-installdash-install -> dash-generate
- Return one
status, onepath_type, onesource_used, and one output contract for the mode that ran.
Inputs
mode:explore,dash-install, ordash-generatequery: required forexploredocs_kind: optional forexplore; useapi-reference,guide,symbol, orsearchwhen the user intent is clearpreferred_source: optional forexplore; useauto,xcode-mcp-docs,dash, orofficial-webmcp_failure_reason: optional forexplorewhen Xcode MCP docs were expected but are currently unavailabledocset_request: required fordash-installanddash-generateapproval: required before side-effectful Dash install actions- Defaults:
- runtime entrypoint: executable
scripts/run_workflow.py exploresource order isxcode-mcp-docs,dash,official-web- Dash install source priority is
built-in,user-contributed,cheatsheet - default search result limit is
20 - default search snippets setting is
true
- runtime entrypoint: executable
Outputs
statussuccess: the selected mode completed on its primary or fallback pathblocked: prerequisites, approval, or usable docs sources are missinghandoff: the current mode is handing off to the next docs mode
path_typeprimary: the selected mode completed normallyfallback: the selected mode completed through its documented fallback path
outputmodesource_usedconfigured_orderorsource_pathmatches- install result or generation guidance when applicable
- one next step when follow-up is required
Guards and Stop Conditions
- Do not run Dash install actions without explicit user approval.
- Do not invent Apple or Swift doc sources, Dash identifiers, or catalog matches.
- Stop with
blockedwhenexplorehas no usable docs source after applying the documented fallback order. - Stop with
blockedwhendash-installordash-generatelacks a concrete docset request. - Keep
explore,dash-install, anddash-generatein forward order; do not blend them into competing primary workflows.
Fallbacks and Handoffs
explorefalls back in this order: Xcode MCP docs, then Dash, then official web docs.- Explicit user preference overrides the default source order when that preference is usable.
dash-installhands off todash-generatewhen no installable catalog match exists.dash-generatefalls back from stable automation guidance to deterministic manual guidance.- Recommend
xcode-build-run-workflowdirectly when the user’s task shifts from docs exploration to Apple or Swift build, run, diagnostics, toolchain, or mutation work. - Recommend
xcode-testing-workflowdirectly when the user’s task shifts from docs exploration to Apple or Swift test work. - Recommend
bootstrap-xcode-app-projectdirectly when the user needs new native app scaffolding. - Recommend
sync-xcode-project-guidancedirectly when an existing Xcode app repo needs guidance sync rather than docs help. scripts/run_workflow.pyis the only local runtime entrypoint for docs source selection, install gating, and follow-up behavior; helper scripts remain implementation details behind it.
Customization
- Use
references/customization-flow.md. scripts/customization_config.pystores and reports customization state.scripts/run_workflow.pyloads and enforces the runtime-safe knobs documented inreferences/customization-flow.md.
References
Workflow References
references/xcode_mcp_docs.mdreferences/dash_mcp_tools.mdreferences/dash_http_api.mdreferences/dash_url_and_service.mdreferences/official_web_docs.md
Contract References
references/stage-handoff-contract.mdreferences/automation-prompts.mdreferences/customization-flow.md
Support References
- Recommend
references/snippets/apple-xcode-project-core.mdwhen the user needs a reusable Apple and Xcode-project baseline snippet in their own repo alongside Apple or Swift docs workflows. references/catalog_built_in_docsets.jsonreferences/catalog_user_contrib_docsets.jsonreferences/catalog_cheatsheets.jsonreferences/snippets/apple-xcode-project-core.md
Script Inventory
scripts/run_workflow.pyscripts/dash_api_probe.pyscripts/dash_catalog_match.pyscripts/dash_catalog_refresh.pyscripts/dash_url_search.pyscripts/dash_url_install.py
More from gaelic-ghost/apple-dev-skills
bootstrap-swift-package
Bootstrap new Swift Package Manager projects with consistent defaults and fast setup. Use when creating a new Swift package (library, executable, or tool), scaffolding package structure, applying standard platform/version defaults, initializing git, running first-step validation, or when the user asks to customize bootstrap defaults in this skill.
10swift-package-agents-maintainer
Create, update, and maintain a canonical AGENTS.md (agents file) across Swift Package repositories. Use when Codex needs to update AGENTS.md for Swift packages, sync agents files across repos, enforce shared policy baselines, detect drift in automation, apply canonical templates, or customize this skills sync policy.
10dash-docset-install-generate
Install, guide installation, and generate Dash.app docsets or cheatsheets on macOS. Use when the user asks to add missing Dash docsets, install from built-in or contributed sources, install cheat sheets, subscribe to feeds, generate custom docsets, verify installation, or customize this skills install/generation policy.
10apple-swift-cli-fallback
Execute automatic fallback through official Apple and Swift CLI tooling when Xcode MCP paths are unavailable or insufficient. Use for xcodebuild, xcrun, SwiftPM, swiftly toolchain workflows, command-availability remediation, or when the user asks to customize this skills fallback behavior.
9xcode-mcp-first-executor
Execute Apple and Swift tasks through Xcode MCP tools first, with strict workspacePath-based tab resolution and structured fallback handoff when MCP tools are unavailable, time out, or cannot satisfy the operation. Use for MCP-first execution routing or when the user asks to customize this skills MCP retry/handoff policy.
9apple-dev-safety-and-docs
Enforce mutation safety in Xcode-managed projects and route Apple and Swift documentation through Dash local-first policy with cooldown-gated advisory messaging. Use for risk checks, consent gating, docs fallback decisions, skill-install guidance, or when the user asks to customize this skills safety/docs behavior.
9