Skip to content

Commit 4099465

Browse files
committed
doc(agents): how to get sinch api docs
1 parent 156ab78 commit 4099465

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

.github/copilot-instructions.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,14 @@ Before considering work complete:
587587

588588
---
589589

590+
## Sinch API Documentation
591+
592+
When suggesting code for Sinch API integrations:
593+
1. **Check `.local/llms.txt` first** - Local cached copy of Sinch API documentation
594+
2. **Fetch from https://developers.sinch.com/llms.txt** if local copy unavailable
595+
596+
The llms.txt file contains complete API documentation for Sinch Conversations, webhooks, message formats, and authentication.
597+
590598
## Development Tooling: Taskfile vs Composer Scripts
591599

592600
This module uses **both Taskfile and Composer scripts** with distinct responsibilities:

CLAUDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,6 +678,28 @@ private function redirect(Request $request): RedirectResponse
678678
- This blocks the iframe with: "Firefox will not allow Firefox to display the page if another site has embedded it"
679679
- Solution: Always use `$request->server->get('SCRIPT_NAME')` for redirects
680680

681+
## Sinch API Documentation
682+
683+
### For AI Agents
684+
685+
When working with Sinch APIs (Conversations, SMS, etc.), reference the official documentation:
686+
687+
1. **Check local copy first**: `.local/llms.txt` (cached copy of Sinch API docs)
688+
2. **Fetch latest if needed**: https://developers.sinch.com/llms.txt
689+
690+
The `llms.txt` file contains comprehensive API documentation for:
691+
- Sinch Conversations API
692+
- Message formats and types
693+
- Webhook events
694+
- Authentication
695+
- Error handling
696+
697+
**When to use:**
698+
- Implementing API integrations
699+
- Understanding webhook payloads
700+
- Debugging API responses
701+
- Adding new Sinch features
702+
681703
## Development Tooling: Taskfile vs Composer Scripts
682704

683705
### Separation of Concerns

Taskfile.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,13 @@ tasks:
193193
- composer update
194194
- echo "✅ Composer dependencies updated"
195195

196+
docs:sinch:
197+
desc: Fetch latest Sinch API documentation for AI agents
198+
cmds:
199+
- mkdir -p .local
200+
- curl -fsSL https://developers.sinch.com/llms.txt -o .local/llms.txt
201+
- echo "✅ Sinch API docs updated in .local/llms.txt"
202+
196203
openemr:prebuild:
197204
desc: Pre-build OpenEMR dependencies (speeds up first Docker start)
198205
cmds:

0 commit comments

Comments
 (0)