llms.txt في MkDocs

إلى أين يذهب الملف

ينشئ MkDocs docs_dir (افتراضياً docs/) في site/ مجلد. وتصبح ملفات Markdown صفحات HTML؛ وكل ملف آخر، بما فيه .txt، ويُنسخ إلى المسار المطابق في site/. لذلك docs/llms.txt يُقدَّم على العنوان /llms.txt.

تعامل مع الملف كخريطة منتقاة لمجموعة التوثيق. أدرج أدلة التثبيت ومرجع الإعداد وصفحات API وملاحظات الترقية وسجل التغييرات، لكن تجنب إغراق الملف بكل صفحة منشأة. والقائمة الأصغر التي تتم صيانتها أسهل تدقيقاً للمساعدات والبشر.

الطريقة: دليل docs/

1. أضف الملف: touch docs/llms.txt
2. ارسم خريطة لصفحات التوثيق الأساسية لديك (فالوثائق هي بالضبط ما تريده المساعدات هنا):

# Your Project Docs

> Documentation for Your Project: installation, usage, and API reference.

## Guides

- [Installation](https://yourdomain.com/install/): setup and requirements.
- [User guide](https://yourdomain.com/guide/): day-to-day usage.

## Reference

- [API](https://yourdomain.com/api/): full reference.

3. ابنِ وانشر: mkdocs build (أو mkdocs gh-deploy لـ GitHub Pages).

أبقِه خارج شريط التنقّل

التحقق من الإعداد

curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain

هل تنشر توثيقاً إلى GitHub Pages؟ انتبه إلى تحفظ المسار الأساسي في دليل GitHub Pages. ويُغطّى إنشاء محتوى الملف في دليل إجرائي؛ تحقّق منه باستخدام المدقّق.