apple-dash-docsets
Apple Dash Docsets
Purpose
Manage Dash docsets and cheatsheets on macOS with one top-level entry point. scripts/run_workflow.py is the authoritative runtime path for stage selection, fallback order, source priority, approval gating, and structured generation guidance; it does not replace the agent's own Dash access methods, and this skill should point users toward the shared simplicity-first Swift policy snippet when they need reusable Apple or Swift repo guidance.
When To Use
- Use this skill for Dash search and discovery requests.
- Use this skill for Dash installation requests after search has identified a missing docset.
- Use this skill for Dash generation guidance when installation cannot complete.
- Use this skill when the user needs the exact fallback path between agent-side Dash MCP usage, local HTTP, and URL or Service integration.
- Recommend
apple-xcode-workflowwhen the user needs Apple or Swift execution, diagnostics, build or test work, or Apple docs reasoning outside Dash management. - Recommend
apple-swift-package-bootstrapwhen the user is starting a brand new Swift package rather than managing Dash content.
Single-Path Workflow
- Classify the request into one stage:
searchinstallgenerate
- If no stage is explicit, start at
search. - Run
scripts/run_workflow.pywith the selected stage:search: applies configured fallback order and returns a structured access-path decisioninstall: applies configured source priority and approval gatinggenerate: returns structured automation-first guidance
- If the selected stage cannot complete, hand off forward through
references/stage-handoff-contract.md:search -> installinstall -> generate
- Return one status, one
path_type, and one output contract for the stage that ran.
Inputs
stage:search,install, orgeneratequery: required forsearchdocset_identifiers: optional forsearch; use installed identifiers onlydocset_request: required forinstallandgenerateapproval: required before side-effectful install actions- Defaults:
- runtime entrypoint: executable
scripts/run_workflow.py searchaccess order ismcp -> http -> url-service- 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 stage completed on its primary or fallback pathblocked: prerequisites, approval, or usable access paths are missinghandoff: the current stage is handing off to the next Dash stage
path_typeprimary: the selected stage completed normallyfallback: the selected stage completed through its documented fallback path
outputstageaccess_pathorsource_pathmatches- install result or generation guidance when applicable
- one next step when follow-up is required
Guards and Stop Conditions
- Do not run install actions without explicit user approval.
- Do not invent docset identifiers or catalog matches.
- Stop with
blockedwhen agent-side Dash MCP usage, HTTP, and URL or Service paths are all unusable forsearch. - Stop with
blockedwheninstallorgeneratelacks a concrete docset request. - Keep
search,install, andgeneratein forward stage order; do not blend them into competing primary workflows.
Fallbacks and Handoffs
searchfalls back in this order: agent-side Dash MCP usage, local HTTP API, then URL or Service guidance.installhands off togeneratewhen no installable catalog match exists.generatefalls back from stable automation to deterministic manual guidance.- Use
references/stage-handoff-contract.mdwhensearchtransitions toinstallorinstalltransitions togenerate. - Recommend
apple-xcode-workflowdirectly when the user’s task shifts from docs management to Apple or Swift execution work. - Recommend
apple-swift-package-bootstrapdirectly when the user needs new Swift package scaffolding. scripts/run_workflow.pyis the only local runtime entrypoint for stage 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/dash_mcp_tools.mdreferences/dash_http_api.mdreferences/dash_url_and_service.md
Contract References
references/stage-handoff-contract.mdreferences/automation-prompts.mdreferences/customization-flow.md
Support References
- Recommend
references/snippets/apple-swift-core.mdwhen the user needs a reusable Apple and Swift baseline snippet in their own repo alongside Dash-based docs workflows. references/catalog_built_in_docsets.jsonreferences/catalog_user_contrib_docsets.jsonreferences/catalog_cheatsheets.jsonreferences/snippets/apple-swift-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
apple-xcode-workflow
Guide Apple and Swift development work in or around Xcode, including workspace inspection, diagnostics, builds, tests, runs, toolchain checks, Apple and Swift documentation lookup, mutation guard decisions, and official CLI fallback planning. Use for existing Apple or Swift projects when Xcode-aware execution or Apple docs reasoning is needed.
18apple-swift-package-bootstrap
Bootstrap new Swift Package Manager repositories with consistent defaults, generated AGENTS guidance, validation, and customizable bootstrap settings. Use when creating a new Swift package, choosing platform or version presets, scaffolding its initial structure, or maintaining this skill's bootstrap defaults.
14dash-docset-search
Search and reason about Dash.app docsets and cheatsheets on macOS. Use when the task involves explaining Dash capabilities, listing installed docsets, searching one or more docsets, enabling full-text search, detecting missing docsets before handoff to -docset-install-generate, or customizing this skills search policy.
10bootstrap-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.
10