المرجع والأدلة لا يتطابقان
تتغيّر الواجهة البرمجية ولا تتغيّر الأدلة، فيكتشف القارئ ذلك بنفسه.
للمطورين
توثيق API ضمن سير عمل Git.
استورد ملف OpenAPI لتحصل على صفحات للنقاط الطرفية يجرّبها القارئ، واكتب الأدلة بـ Markdown متزامنة مع GitHub، وقدّم لأدوات الذكاء الاصطناعي نصًّا نظيفًا. على السحابة المجانية التجريبية أو على خوادمك.
هل يبدو هذا مألوفًا؟
الوثائق خارج مراجعة الشيفرة
يكتب الكتّاب في أداة والمهندسون في أخرى، ولا أحد يراجع التغيير نفسه.
أدوات الذكاء الاصطناعي تسيء قراءة وثائقك
تجمع المساعدات النص من صفحات HTML بدل أن تحصل على نص نظيف تستفيد منه.
مرجع API
صفحات مرجعية من ملف OpenAPI.
استورد ملف OpenAPI 3.x، فيبني Nibleaf صفحات النقاط الطرفية والمخططات، مع لوحة لتجربة الطلبات من المتصفح.
- تُجلب المراجع الخارجية العامة في ملفك وتُجمع عند الاستيراد
- اكتب الأدلة بجانب المرجع، مع مجموعات الشيفرة وأمثلة الطلب والاستجابة
- قالب Signal مصمّم للوثائق الغنية بالشيفرة
Markdown وGit
أبقِ الوثائق ضمن المراجعة.
اربط مستودع GitHub: تذهب تعديلات المتصفح إلى فرع مخصّص وطلب دمج، وتعود التغييرات المكتوبة في المستودع إلى Nibleaf.
- تُحفظ الصفحات بصيغة Markdown تقرؤها وتقارن نسخها
- لكل طلب دمج رابط معاينة خاص به، مخفيّ عن محركات البحث
- حين تتغيّر الصفحة في المكانين، تحلّ التعارض داخل Nibleaf
أدوات الذكاء الاصطناعي
وثائق تقرؤها أدوات الذكاء الاصطناعي فعلًا.
يقدّم كل موقع ملفي llms.txt وllms-full.txt لأدوات الذكاء الاصطناعي، وتبقى الصفحات الخاصة خارجهما.
- اربط Claude Code أو Cursor أو VS Code بمشروع التوثيق عبر MCP
- مستويات القراءة فقط ومساعد كتابة الدعم والإدارة الكاملة تحصر الصلاحيات
- النشر من المساعد يحتاج دائمًا إلى معاينة حديثة وتأكيد
المتطلبات: معطّل افتراضيًا، فيفعّله أصحاب الاستضافة الذاتية أولًا. متاحة على Nibleaf Cloud، وعند الاستضافة الذاتية بالإصدار v0.2.1 أو أحدث.
الاستضافة الذاتية والإصدارات
شغّله حيث تعمل شيفرتك.
المنتج كله مفتوح المصدر بترخيص AGPL-3.0، مع مُثبِّت Docker Compose لخوادمك، ووثائق مستقلة لكل إصدار من الواجهة البرمجية.
- يحتاج إلى PostgreSQL وذاكرة مؤقتة متوافقة مع Redis وتخزين متوافق مع S3، والتخزين مرفق
- Qdrant للمساعد وClickHouse للتحليلات خدمتان اختياريتان
- يجيب المساعد من الإصدار واللغة اللذين يقرأهما القارئ
كيف تُعدّه فرق المطورين
استورد ملف المواصفات
ارفع ملف OpenAPI، أو أشر إلى رابطه، أو اختره من المستودع المرتبط.
اربط GitHub
اربط المستودع لتمرّ تغييرات الأدلة عبر طلبات الدمج، وأعد استيراد الملف منه حين تتغير الواجهة البرمجية.
اكتب الأدلة
في المحرر أو في محرر الشيفرة، مع مجموعات الشيفرة وأمثلة الطلب والاستجابة.
انشر وأدِر الإصدارات
عاين وانشر، واحتفظ بنسخة مستقلة من الوثائق لكل إصدار من الواجهة البرمجية.
أسئلة المطورين
ما إصدارات OpenAPI المدعومة؟
OpenAPI 3.x. يتحقق Nibleaf من صحة الملف ويجمع المراجع الخارجية العامة عند الاستيراد.
هل تعمل تجربة الطلبات مع أي واجهة برمجية؟
تنطلق الطلبات من متصفح القارئ إلى واجهتك، فيجب أن تسمح بها واجهتك (CORS) وأن يقدّم القارئ بيانات اعتماده. ولا يحاكي Nibleaf واجهتك ولا يراقبها.
هل أستطيع كتابة الوثائق في محرر الشيفرة؟
نعم. مع المزامنة الثنائية مع GitHub تعدّل ملفات Markdown في المستودع وتفتح طلبات الدمج كالمعتاد. أما مستودعات GitLab العامة وغيرها فتُستورد في اتجاه واحد.
ماذا تحصل عليه أدوات الذكاء الاصطناعي من وثائقي؟
يقدّم كل موقع ملفي llms.txt وllms-full.txt، في حدود ما يحق للقارئ رؤيته. ويستطيع فريقك أيضًا ربط المساعدات الذكية بالمشروع عبر MCP.
ماذا تحتاج الاستضافة الذاتية؟
Docker Compose مع PostgreSQL وذاكرة مؤقتة متوافقة مع Redis وتخزين متوافق مع S3 (مرفق افتراضيًا). أما Qdrant وClickHouse فاختياريتان. والصورة المنشورة مبنية لمعمارية linux/amd64.
انشر توثيق API من سير عملك.
ابدأ مجانًا على Nibleaf Cloud، أو شغّله على خوادمك.