Overhaul iOS Shortcuts documentation with detailed workflows and troubleshooting

[Copilot]

The iOS Shortcuts section showed outdated API patterns and lacked actionable guidance. Users needed step-by-step instructions for creating shortcuts with photo and/or description inputs.

Changes

Workflow Options

• Photo + Description: Combined workflow with optional preferences input
• Photo Only: Single-tap photo capture for automatic profile creation
• Description Only: Text-based profile requests without image
• Analysis-Only: Coffee identification without profile creation

Documentation Structure

• Step-by-step iOS Shortcuts app actions with exact configuration
• Form field specifications (file, user_prefs) and HTTP methods
• Troubleshooting section: connection failures, invalid responses, upload issues
• Tips section: photography guidance, preference examples, extraction styles
• <PI_IP> placeholder convention defined upfront

API Endpoints

All workflows reference current endpoints:

• /analyze_and_profile - accepts file and/or user_prefs form data
• /analyze_coffee - accepts file for analysis without profile creation

Example: Photo + Description Workflow

1. Take Photo (Show Camera Preview = On)
2. Ask for Input ("Any preferences?", allow empty)
3. Get Contents of URL
   - POST http://<PI_IP>:8000/analyze_and_profile
   - Form: file=Photo, user_prefs=Provided Input
4. Show Notification (Contents of URL)

Pre-built shortcut link placeholder added for future distribution.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Shortcuts integration documentation improvement</issue_title>
<issue_description>The iOS shortcut integration shows the old api and isn't complete, needs an overhaul to use the new api call, and also refactor to enable the photo and/or description workflow, later a link to a pre-built shortcut should be added</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Shortcuts integration documentation improvement #21

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.