مرحباً @Avadh_Sonagara أهلاً وسهلاً!
لا توجد عملية تحميل منفصلة للسوق للعُقد. النشر يتم عبر npm مع التحقق: يجب أن يبدأ اسم الحزمة بـ n8n-nodes- أو @scope/n8n-nodes-، وn8n-community-node-package يجب أن يكون في الكلمات المفتاحية، وعُقدك وبيانات اعتماداتك يجب أن تُعلن تحت خاصية n8n في package.json. بمجرد وضعه على npm تقدم به على Login - n8n.io.
قائمة التحقق التي تراجعها n8n قبل التحقق: السقالة باستخدام CLI n8n-node، اجتياز إرشادات التحقق التقني بدون أي تبعيات وقت التشغيل على الإطلاق، اتباع إرشادات تجربة المستخدم، إرسال README، والنشر عبر سير عمل GitHub Actions مع بيان الأصل. هذا الأخير أصبح إلزامياً للتحقق من بوابة المنشئين منذ 1 مايو 2026، الحزم المنشورة من جهاز محلي غير مقبولة.
التوثيق لا يدخل مستودع n8n-docs. المتطلب هو README في حزمة npm أو في مستودع عام مرتبط، بحيث يكون ذلك README دليل المستخدم الخاص بك. مستودع n8n-docs يحتوي على قوالب صفحات يمكنك نسخ هيكلها له، app-nodes.md وcredentials.md وcommon-issues.md موجودة في مجلد document-templates/ الخاص به: Contribution guide for n8n Docs | Contribute | n8n Docs
سير العمل يمر عبر حساب مركز المنشئين نفسه بدلاً من المستودع:
لدي التباس صغير فيما يتعلق بجزء التوثيق. هل يمكنك من فضلك تأكيد ما إذا فهمت هذا بشكل صحيح؟
بالنسبة لعقدتنا المخصصة، هل يجب أن تكون جميع التوثيقات الموجهة للمستخدم (مشابهة لقوالب app-nodes.md و credentials.md و common-issues.md وما إلى ذلك) مضمنة في README.md الخاص بحزمتنا / مستودع عام مرتبط به؟
نحن لا نحتاج إلى إنشاء PR أو تقديم توثيقنا إلى مستودع n8n-docs، أليس كذلك؟
بمجرد تقديم العقدة للتحقق من خلال Creator Portal، هل يتولى فريق n8n نشر/دمج التوثيق على جانب n8n، أم أن هناك خطوة تقديم توثيق منفصلة نحتاج إلى إكمالها؟
أنا بالفعل على دراية بعملية نشر العقدة/الحزمة. التباس الوحيد لدي هو عن عملية نشر التوثيق وما إذا كنا بحاجة إلى فعل أي شيء منفصل مع n8n-docs.
نعم على الاثنين الأولين.
ملف README في حزمة npm أو المستودع العام المرتبط هو التوثيق الموجه للمستخدم، وتحدد إرشادات التحقق ما يجب أن يحتويه: تعليمات الاستخدام وسير العمل مع الأمثلة وتفاصيل المصادقة باللغة الإنجليزية فقط. قوالب app-nodes.md وcredentials.md هي مجرد هيكل يمكنك نسخه فيه.
لا توجد طلب دمج لـ n8n-docs. يجب أن تُقترح الصفحات الجديدة هناك كمسألة أولاً حتى تتمكن فريق التوثيق من تأكيد الأسلوب، وقسم العُقد المجتمعية من التوثيق يغطي تثبيت واستخدام العُقد المجتمعية بشكل عام بدلاً من الاحتفاظ بصفحة مرجعية لكل عقدة.
لا توجد خطوة توثيق منفصلة بعد الإرسال أيضاً. يجلب التحقق الحزمة من npm، وعرض التفاصيل الذي يراه المستخدمون في لوحة العُقد مُنشأ من تعريف العقدة في تلك الحزمة، لذا فإن إبقاء ملف README محدثاً على npm هو كل شيء.
كما أفهمه، نحتاج فقط إلى الحفاظ على التوثيق في ملف README.md الخاص بنا (إما في حزمة npm أو في مستودع عام مرتبط)، متبعاً هيكل قوالب app-nodes.md و credentials.md و common-issues.md. هل هذا صحيح؟
أيضاً، هل يجب تضمين جميع هذه الأقسام (app-nodes و credentials و common-issues وغيرها) معاً في ملف README.md واحد، أم يجب إنشاء ملفات توثيق منفصلة لكل قسم؟
وبمجرد تقديم العقدة من خلال Creator Portal، سيستخدم n8n التوثيق ومعلومات الحزمة التي نقدمها ولا يلزم تقديم توثيق منفصل من طرفنا، أليس كذلك؟
أيضاً، فريقك سيقوم بنشر التوثيق بناءً على README الخاص بي، أليس كذلك؟
احتفظ به ملف README.md واحد في جذر الحزمة. هذا هو الملف الذي يعرضه npm على صفحة الحزمة وهو الملف الذي يقرأه المراجعون، لذا فإن أي شيء تقسمه إلى ملفات منفصلة لن يُرى إلا إذا كان README يرتبط به. استخدم قوالب app-node و credential و common-issues كعناوين أقسام داخل ملف README الواحد هذا بدلاً من أن تكون وثائق مستقلة. لا يستضيف n8n أو ينشر مجددًا مستنداتك: رابط “المستندات” الذي يظهر في لوحة العقدة يأتي من resources.primaryDocumentation.url في ملف *.node.json الخاص بكل عقدة، لذا وجهه إلى صفحة مستودعك أو عنوان URL الخاص بمستنداتك. بعد النشر، افتح العقدة في سير عمل وانقر على هذا الرابط للتأكد من أنه ينقل بنجاح بدلاً من إرجاع خطأ 404.
شيء عملي واحد أود أن أضيفه من جانب نموذج سير العمل: تعامل مع التوثيق كجزء من سير العمل، وليس شيئًا تضيفه بعد انتهاء البناء.
للحصول على سير عمل جاهز للتقديم، أود أن يفهم شخص ما:
- ما الذي يفعله سير العمل
- ما هي بيانات الاعتماد المطلوبة
- ما هي المدخلات التي يتوقعها
- ما هو الإخراج الذي يجب أن يروه
- أين يمكن أن يفشل
- كيفية اختباره بأمان
ملاحظات لاصقة داخل لوحة العمل تساعد كثيرًا لأنه يمكن لشخص ما فتح سير العمل واتباع المسار دون قراءة دليل منفصل أولاً. كنت سأبقي ملف README نظيفًا، لكن سير العمل نفسه يجب أن يشرح القرارات والتسليمات المهمة.