وكلاء الذكاء الاصطناعي
كل صفحة في الموقع متاحة كـ markdown، بالإضافة لملف كامل للموقع ومواصفة OpenAPI. وجّه مساعد الأكواد بتاعك للمصادر دي بدل ما يقرأ الـ HTML.
لو بتبني بمساعد أكواد، إداله مصادر الـ markdown بدل الصفحات المعروضة. كل صفحة توثيق بتقدّم markdown نضيف على رابط متوقّع، والموقع كله متاح كملف واحد. من غير قراءة HTML ولا scraping.
هات صفحة واحدة كـ markdown
كل صفحة فيها زرار Copy Markdown تحت عنوانها. بينسخ الصفحة كلها كـ markdown، جاهزة تتلزق في محادثة مع مساعدك. وقائمة Open اللي جنبه فيها رابط ملف الـ markdown الخام، وتقدر تفتح الصفحة كـ prompt في ChatGPT أو Claude.
الأدوات اللي بتجيب الصفحات بنفسها مش محتاجة الزراير. ضيف .md أو .mdx لآخر أي رابط توثيق:
curl https://docs.xpay.app/ar/integrate/idempotency.mdده بيشتغل على كل صفحة في اللغتين. غيّر البادئة ar لـ en تجيب النسخة الإنجليزية. وإرسال Accept: text/markdown للرابط العادي بيرجّع نفس المحتوى، وكل صفحة شايلة وسم <link rel="alternate" type="text/markdown"> في الـ head بتاعها، فالوكيل يقدر يكتشف رابط الـ markdown لوحده.
هات الموقع كله
تلات ملفات بيغطّوا سطح التوثيق كامل.
| الملف | بيحتوي على إيه |
|---|---|
/llms.txt | فهرس بكل صفحة مع عنوانها ووصفها ورابطها. ابدأ من هنا. |
/llms-full.txt | الأدلة ومرجع الـ SDK في ملف markdown واحد. مرجع الـ API مش متضمّن فيه: استخدم /openapi.json أو الـ .md بتاع صفحة واحدة لده. |
/openapi.json | مواصفة الـ API القابلة للقراءة آليًا: كل endpoint وobject وحقل وenum. |
صفحات مرجع الـ API مولّدة من مواصفة OpenAPI، والـ markdown بتاعها شايل نفس المعاملات وأجسام الطلبات وحقول الردود اللي بتظهر في الصفحات المعروضة. الحقل اللي نوعه مورد رئيسي (Charge أو Refund أو Price) بيظهر كرابط لصفحة الـ object بتاعه، وأي شكل متداخل تاني بيتفرد في مكانه.
تستخدم أنهي مصدر
اختار حسب حجم السياق اللي أداتك تقدر تشيله.
- بتبني تكامل: حمّل
/llms-full.txtمرة واحدة وسيب المساعد يبحث فيه. - بترد على سؤال واحد: هات الصفحة لوحدها بـ
.md، واستخدم/llms.txtعشان تلاقي الرابط الصح. - بتولّد عميل أو بتتحقق من الطلبات: استخدم
/openapi.jsonعلى طول. هي نفس المواصفة اللي مرجع الـ API بيتعرض منها، فعمرها ما بتختلف عن الصفحات دي.