generate-docs

Build symbol graph documentation for the current Xcode project and make it discoverable to future LLM sessions. The dispatching command will provide context including the plugin root path and optional scheme argument.

For the visual workflow diagram, see ./references/generate-docs-workflow.mmd relative to the plugin commands directory.

Step 1: Run generate-docs.sh

Execute the helper script which handles scheme discovery, docbuild, symbol graph extraction, and transformation to structured CSVs:

bash <plugin-root>/commands/references/generate-docs.sh [scheme]

• The <plugin-root> path and optional scheme argument will be provided by the dispatching command

The script outputs one JSON line per step with the structure: {"step": "...", "status": "...", "output": "..."}.

Step 2: Handle Results

Parse the JSON output from the script:

1. preflight step: If status is "error", report the error and stop
2. scheme step: If status is "error", report available schemes and stop
3. docbuild step: If status is "error", report the build error and suggest running /build-and-run first to fix compilation issues
4. extract step: If status is "warning", report the warning and stop (no symbol graphs to transform)
5. transform step: If status is "error", report the transform error and stop
6. summary step: Extract modules, types, methods, relationships counts from the output object

Step 3: Update .gitignore

Check if .gitignore exists in the project root:

• If .gitignore doesn't exist, create it
• Check if .build/ is already covered (which would include all subdirectories)
• If not, check for .build/api-docs/, .build/docs/, and .build/symbol-graphs-raw/ individually
• Append any missing entries

Do NOT add a blanket .build/ entry — the project may manage that differently.

Step 4: Update CLAUDE.md

Check if CLAUDE.md exists in the project root. If not, create it.

Search for the marker <!-- generate-docs --> in CLAUDE.md:

• If found, replace everything from <!-- generate-docs --> to <!-- /generate-docs --> (inclusive) with the block below
• If not found, append the block below to the end of CLAUDE.md