الوثائق
أدلة وسير العمل
إجراءات كاملة لتصميم الأجزاء، وإنشاء برامج التشغيل الآلي، وبناء عمليات التكامل، ومراجعة التغييرات، وتشغيل سطح المكتب.
مترجم تلقائيًا من الإنجليزية. عرض الأصل بالإنجليزية
اختر دليلاً
- بداية سريعة: تثبيت التبعيات، وبدء تشغيل سطح المكتب، وتحديد موقع قاعدة البيانات الخاصة به.
- ثَبَّتَ: قم بتنزيل نسخة سطح المكتب المنشورة، وتحقق من مجموعها الاختباري، وتمييزها عن الخروج المصدر.
- الحسابات: تحرير الملف الشخصي وكلمة المرور ومفاتيح API وهوية git في الاستوديو المحلي.
- التنمية المحلية: تشغيل معاينة المتصفح أو السايدكار الحقيقية، وتكوين العمليات، وتشخيص بدء التشغيل.
- رمز المساهمة: تحديد موقع الوحدات وتغيير العقود المشتركة وتحديد الشيكات.
- الحزم: التنقل بين مسؤوليات مساحة العمل ونقاط الدخول العامة.
يحتوي موقع سطح المكتب والسايدكار والرفيق وموقع التوثيق على أوامر تشغيل ونماذج استمرارية مختلفة. اختر وقت التشغيل الذي يمارس السلوك الذي تقوم بتغييره. تُعد أداة المتصفح مفيدة للعمل على الشاشة؛ تحتاج تغييرات قاعدة البيانات والتدفق والترخيص إلى الخادم الحقيقي.
فهم وقت التشغيل
تنفذ الحزمة الأساسية الهندسة ومسارات الأدوات والمشاركات والتحقق. تحدد حزمة API المخططات المشتركة ونقاط النهاية والعملاء الذين تم إنشاؤهم. يجمع السايدكار هذه العقود مع المستودعات وSQLite وAI والمكونات الإضافية والتحكم في الإصدار وخدمات سير العمل. يعرض سطح المكتب هذه الخدمات من خلال اتصال واجهة برمجة التطبيقات (API) المحلي والواجهة الأصلية.
يتصل رفيق iOS من خلال بوابة HTTPS منفصلة مثبتة. تعمل حزمة الويب على تشغيل موقع وثائق Astro وتكامل الاستوديو المحلي. هؤلاء عملاء منفصلون ويجب ألا يُفترض أنهم يشاركون مسار قاعدة البيانات أو سياق الأمان.
استخدم وثائق Effect API المثبتة
تم تثبيت التأثير على 4.0.0-rc.112. يتم تضمين الوثائق المطابقة للإصدار ضمن نسخة مساحة العمل المثبتة، مثل packages/db/node_modules/effect/ai-docs/src/. استشره قبل تغيير الخدمات أو الطبقات أو معالجة الأخطاء أو كود HTTP.
الأوامر المشتركة
bun install
bun run desktop:dev
bun run --filter @cadcamfun/desktop dev
bun run --cwd packages/web start desktop:dev يبني السايدكار الحقيقية وينظم عمليات الهجرات قبل فتح Tauri. سطح المكتب dev يبدأ البرنامج النصي Vite على المنفذ 1420؛ وبدون عنوان URL السايدكار، فإنه يستخدم واجهة برمجة التطبيقات للمعاينة في الذاكرة. الويب start يبدأ البرنامج النصي بـ Astro فقط؛ إنه dev يبدأ البرنامج النصي أيضًا واجهة برمجة تطبيقات Studio المحلية.
| مهمة | يأمر |
|---|---|
| اختبارات مساحة العمل | bun run test |
| التحقق من نوع مساحة العمل | bun run typecheck |
| فحص نوع سطح المكتب | bun run --filter @cadcamfun/desktop typecheck |
| إعادة إنشاء عملاء API | bun run generate، ثم bun run generate:check |
| إنشاء/تطبيق عمليات ترحيل قاعدة البيانات | bun run db:generate, bun run db:migrate |
| تجميع موارد السايدكار والمرحلة | bun run build:sidecar |
| بناء الواجهة الأمامية لسطح المكتب | bun run build:desktop |
| تحقق من التنقل في الوثائق | bun run --cwd packages/web check |
إنشاء الترحيل مخصص لتغييرات المخطط، وليس شرطًا أساسيًا للتثبيت. تقوم طبقة قاعدة البيانات بإنشاء قاعدة بيانات جديدة وتطبق عمليات الترحيل المتاحة عند فتحها. راجع البداية السريعة قبل اختيار مسار قاعدة بيانات CLI.
يتم تعريف البرامج النصية الجذرية في المستودع package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate، و db:migrate.
ابدأ بتدفق ملموس
لتطوير سطح المكتب، افتح مشروعًا، وقم بإنشاء رسم أو تحميله، وافحص تدفق CAD/CAM الذي تنوي تعديله. اتبع محول المسار الخاص به في شاشة الميزات وحدد موقع استدعاء API والمعالج. بالنسبة لعمل الخادم، استخدم المخطط والمعالج والخدمة وسلسلة المستودع لتحديد مكان حدوث التحقق من الصحة والملكية والاستمرارية.
بالنسبة للعمل المصاحب، قم بتثبيت إصدار iOS أصلي، وتمكين بوابة سطح المكتب، والإقران من خلال رمز الاستجابة السريعة الخاص به. بالنسبة إلى أعمال التوثيق، ابدأ تشغيل Astro، وافتح المسار الذي تم تغييره، وقم بتشغيل إنشاء الويب لاكتشاف أخطاء القالب والعرض المسبق.
حافظ على حدود واضحة
احتفظ ببيانات الاعتماد خارج المصدر والأمثلة والسجلات ولقطات شاشة المتصفح. استخدم العناصر النائبة في الوثائق وقم بتوفير تكوين وقت التشغيل من خلال العملية المدعومة أو إعدادات التطبيق. حافظ على مزامنة العملاء الذين تم إنشاؤهم مع عقودهم، وقم بإنشاء عمليات ترحيل SQL من المخطط بدلاً من تحرير ملفات الترحيل التي تم إنشاؤها.
استخدم دليل بيانات منفصلًا يمكن التخلص منه لاختبارات التكامل والتجارب المحلية. إن تجهيزات المعاينة، وقاعدة بيانات ترحيل CLI، وقاعدة بيانات التطبيقات المجمعة، والبوابة المصاحبة لها أغراض مميزة؛ يجب أن يكون اختيار واحد واضحًا.
ابحث عن سير العمل المناسب
| أريد أن… | ابدأ هنا | نتيجة ناجحة |
|---|---|---|
| قم بتثبيت إصدار سطح المكتب المنشور | ثَبَّتَ | يتم تنزيل برنامج التثبيت المطابق من إصدار GitHub المحدد، ويتطابق المجموع الاختباري الخاص به SHA256SUMS. |
| قم بتشغيل الخروج الأصلي لسطح المكتب | افتح سطح المكتب | يفتح Tauri والسايدكار الحقيقية تجيب على الصحة؛ يمكن إعادة فتح البيانات المحفوظة. |
| تحرير الشاشة دون تجميع Rust | اختر عمليات التطوير | يقدم Vite الشاشة إما بواجهة برمجة التطبيقات (API) أو واجهة برمجة التطبيقات (API) المحددة بشكل صريح. |
| قم بتوصيل الهاتف | قم بإقران رفيق iOS | يقوم جهاز سطح مكتب مسمى بالمصادقة من خلال HTTPS المثبت. |
| إضافة أو تغيير الطلب | تغيير العقود المشتركة | يوافق المخطط والمعالج والعملاء والاختبارات والوثائق. |
| تضمين إطار العرض | دمج محرر الرسم و تشغيل التحكم | يتردد صدى تغييرات الرسم من خلال الدعائم وأدوات التحكم الأصلية في وقت التشغيل. |
| بناء المثبتات | فحص خيارات البناء | يتم إنتاج الأصول المستهدفة الصحيحة وعمليات الترحيل والتوقيعات وفهرس الإصدار والتحقق منها. |
| التحقيق في البيانات المحلية المفقودة | حدد دليل البيانات | يشير العميل والسايدكار وأداة الفحص إلى قاعدة البيانات المقصودة. |
استخدم دليلاً لسلسلة من الإجراءات والصفحات المرجعية المرتبطة للحصول على تفاصيل المجال والسلوك. اجعل اختيار وقت التشغيل واضحًا طوال سير العمل: يؤدي التغيير من أداة تثبيت للمتصفح إلى أداة سايدكار أصلية إلى تغيير الثبات وبيانات الاعتماد والقدرات الأصلية وسلوك الخطأ.
تعرف على ما يثبته الشيك
الشيكات المختلفة تجيب على أسئلة مختلفة. يمكن لمترجم TypeScript أن يثبت أن استدعاء العميل يطابق توقيعه الذي تم إنشاؤه. يمكن أن يثبت اختبار المعالج الاستجابة المتوقعة ضمن الطبقات المتوفرة. يمكن لتشغيل جهاز محاكاة أصلي ممارسة تثبيت الشهادة وبدء تشغيل التطبيق. لا يثبت أي من هذه الأمور بشكل مستقل أن المثبت الموقع يعمل على كل جهاز مدعوم أو أن مسار الأدوات آمن لجهاز معين.
- سجل وقت التشغيل الدقيق ودليل البيانات المستخدم في الفحص.
- قم بإجراء العملية عبر الحدود التي سيستخدمها المستخدم.
- افحص الحالة المستمرة الناتجة أو القطعة الأثرية المصدرة، وليس فقط نخب النجاح.
- ممارسة مسار الفشل أو الإلغاء المتأثر بالتغيير.
- قم بالإبلاغ عن أي خدمة خارجية أو توقيع أو جهاز أصلي أو تغطية رسومات لا تزال مفقودة.
بالنسبة لأعمال التكامل الحتمية، استخدم دلائل SQLite المعزولة وتركيبات الذكاء الاصطناعي المكتوبة/غير المتصلة بالإنترنت. بالنسبة للسلوك الخاص بالموفر، قم بتدريب الموفر الذي تم تكوينه باستخدام بيانات الاعتماد المناسبة بشكل منفصل. تصف طلبات الأمثلة في هذه الأدلة الأشكال المدعومة؛ تختلف الطوابع الزمنية والمعرفات والمنافذ وبيانات الاعتماد لكل عملية تشغيل.
أدلة عملية
تتبع هذه الأدلة العمليات الكاملة من خلال التطبيق وواجهة برمجة التطبيقات (API) الخاصة به. يتضمن كل منها المدخلات المطلوبة وتغييرات الحالة ذات الصلة وحالات الفشل التي يجب فحصها. استخدم مراجع النظام الفرعي للنماذج الأساسية وصفحات موارد واجهة برمجة التطبيقات للحصول على عقود الحقول والاستجابة الدقيقة.
تصميم وتصنيع
المشاريع من الإنشاء إلى العمل المحفوظ
قم بإنشاء المشاريع والرسومات والمكونات، واستخدم مكتبات الموارد، واحفظ العمل وأعد فتحه، وفهم الملكية، وتمييز إصدارات الموارد عن التزامات المشروع.
سير عمل التصنيع الأصلي
التقاط الهندسة والمخزون والمواد والأدوات والعمليات؛ أرسل مهمة تصنيع أصلية، وفسر المطالبات ومستويات الإصدار، واحتفظ بمستند CAM محمول مطابق.
العملاء والإضافات
عملاء API وSDK
استخدم CadCam.make أو ApiClient.layer مع أشكال الإدخال الحقيقية والنتائج البسيطة والأخطاء المعلنة وأخطاء النقل والإلغاء والترويسات والتدفقات وحدود الإنشاء.
تدفق الذكاء الاصطناعي والانتعاش
ابدأ جلسات الذكاء الاصطناعي على نطاق المشروع واستمر فيها، واستهلك الأحداث المكتوبة، والرد على الأذونات والأسئلة، وقائمة الانتظار أو إحباط العمل، والتعافي بعد فقدان الاتصال.
تأليف البرنامج المساعد للتطبيق
أنشئ مكونًا إضافيًا مدعومًا لـ ai:tool من صادرات البيان والوحدة، ومنح القدرات، والتحقق من صحة الوسائط، والتعامل مع حدود المضيف، وتمييز تثبيت التسجيل عن التنشيط.
العمليات والانتعاش
الفروع والمراجعات وسير العمل
قم بتنفيذ مشروع، وإنشاء فروع الاقتراح، وفحص الاختلافات الهيكلية، ومراجعة طلبات السحب ودمجها، وإصدار سير عمل YAML، وإرسال الشيكات، والتعامل مع المزامنة عن بعد بأمان.
إقران وإدارة رفيق
قم بتمكين بوابة HTTPS لسطح المكتب، وقم بإصدار إقران جهاز، وتوصيل إصدار iOS أصلي بتثبيت الشهادة، وتشخيص الاتصال، وإبطال الوصول إلى الجهاز.
تشخيص فشل سطح المكتب
تتبع بدء التشغيل الأصلي والاستعداد، والتمييز بين الملفات السايدكار المزيفة والحقيقية، وتحديد موقع قاعدة البيانات والسجلات المحددة، وتشخيص أخطاء واجهة برمجة التطبيقات، والاسترداد دون الخلط بين الحالة المخزنة وغير المحفوظة.
هل أنت جديد في البناء المنشور؟ ابدأ في ثَبَّتَ. جديد في الخروج؟ ابدأ بـ بداية سريعة. هل أنت جديد في سلوك HTTP؟ استخدم تجول مع الاستجابات التي تم التقاطها، ثم اختر عميلاً مكتوبًا أو موردًا في الملف مرجع API الكامل.
العمل من خلال مهمة كاملة
إنشاء تصميم محفوظ
قم بإنشاء مشروع واحتفظ بالمعرف الذي تم إرجاعه. قم بإنشاء الرسم أو المكون الخاص به من خلال المجموعة المناسبة على مستوى المشروع. قم بتحرير الشكل الهندسي في مساحة عمل CAD، واحفظ من خلال إجراء الميزة الفعلية لهذا المورد، وأعد فتح المورد المحفوظ للتأكد من استمرار المستند المقصود. إن التحديد الحالي للمحرر وسجل الأوامر ليس بديلاً عن الرسم المخزن.
عندما يقوم عميلان بتحرير نفس البيانات، اتبع دلالات التحديث الحالية لنقطة النهاية بدلاً من افتراض أن كل مورد يتمتع بحماية المقارنة والمبادلة. اقرأ دليل دورة حياة المشروع لاختلافات الرسم/المكونات، وارتباطات الموارد، وفحوصات الوصول، وحدود الاستعادة.
إنتاج نتيجة التصنيع
التقط الشكل الهندسي والموضع والمخزون والمواد والآلات والأدوات وترتيب التشغيل. قم بتشغيل التوليد بهذه المدخلات الصريحة. فحص مسائل النتيجة والأدلة القابلة للتطبيق؛ تحقق من أن البرنامج وNC تتوافق مع اللقطة المقصودة. يعد الحفظ عملية منفصلة ويجب الاحتفاظ بمستند محمول يتوافق مع وحدات البايت المحددة التي يتم حفظها.
يغير القاطع أو المخزون أو النموذج أو إطار العمل الذي تم تغييره المهمة التي يتم تقييمها. إن إعادة استخدام قطعة أثرية سابقة بعد تحرير NC لا ينقل دليلها إلى النص الجديد. ال دليل التصنيع الأصلي يشرح الإعداد والتوليد والمطالبات والتحقق من صحة الاستمرارية والفرق بين برنامج منشور متكامل وأقسام التشغيل المتسلسلة.
دمج مساعد
قم بتكوين موفر على سطح المكتب وتحقق من حالته قبل بدء المحادثة. الحفاظ على هوية المشروع والجلسة، واستهلاك الأحداث بشكل متزايد، وتنفيذ الأذونات وردود الأسئلة من خلال عناصر التحكم في الجلسة المقبولة. عند قطع الاتصال، قم باستعادة الحالة الحالية قبل إعادة إرسال الطلب الذي ربما يكون قد قام بتحرير المشروع.
ال دليل التدفق يغطي الاسترداد والإلغاء ومتابعة القبول. ال دليل العميل يشرح لماذا لا يمكن التعامل مع قيم نتائج الوعد، وأجسام HTTP التي تم طرحها، وأخطاء التأثير، وإكمال الدفق كمغلف عالمي واحد.
تسجيل ومراجعة التغيير
احفظ مورد العمل، وافحص حالة المشروع، والتزم بالحالة المقصودة على الفرع المقصود. قم بمراجعة الاختلافات الهيكلية وافتح طلب سحب محلي عندما ينبغي اقتراح التغيير بدلاً من اعتماده بشكل مباشر. حل أحكام المراجعة والتعارضات المحظورة قبل الدمج.
تعريفات سير عمل الإصدار مع المشروع، ثم فحص الالتزام المحدد لكل عملية تشغيل ومخرجات الفحص الفردية. إن التشغيل الناجح الذي تخطى فحوصات التشغيل الآلي لا يوفر أدلة تشغيلية. اقرأ الفروع ودليل سير العمل قبل أتمتة خطوة الكتابة أو تكوين مرآة عن بعد.
تشغيل العميل الثاني
قم بتمكين البوابة المصاحبة عن عمد، وقم بإنشاء اقتران جهاز مسمى بشكل فردي، وقم بتوصيل البنية الأصلية التي تتضمن تثبيت الشهادة. احتفظ بعنوان سطح المكتب الكامل وبصمة الإصبع والرمز المميز للجهاز باعتباره الاتصال المقترن. اقرأ سياسة المسار الحالية قبل افتراض أن الهاتف للقراءة فقط أو غير مقيد.
عند انتهاء الوصول، قم بإلغاء الجهاز من سطح المكتب؛ لا تؤدي إزالة الاتصال على الهاتف وحده إلى إلغاء الرمز المميز من جانب الخادم. ال دليل الاقتران يفصل تشخيص الشبكة، وتوافر النقل الأصلي، وهوية الشهادة، وإلغاء الرمز المميز.
أدلة حسب المهمة والوقت
| مرشد | سوف تفعلها | الاحتياجات |
|---|---|---|
| ثَبَّتَ | قم بتنزيل إصدار سطح المكتب المنشور | صفحة التحميل |
| الحسابات | تحرير الملف الشخصي وكلمة المرور والمفاتيح وهوية git | الاستوديو المحلي |
| بداية سريعة | تثبيت واختبار وفتح سطح المكتب | Bun، Rust |
| التنمية المحلية | قم بتشغيل كل عملية بمفردها واختر الاختبارات الصحيحة | استنساخ |
| جولة API | قم بتقديم طلبات حقيقية باستخدام حليقة وشاهد الردود | سايدكار جارية |
| عملاء API | استخدم Promise SDK وعميل Effect، وتعامل مع الأخطاء والتدفقات | TypeScript |
| دورة حياة المشروع | إنشاء مشروع وحفظه وإعادة فتحه وإصداره | سايدكار جارية |
| تصنيع وطنى | قم بإنشاء برنامج تم التحقق منه وحفظه | سايدكار جارية |
| تدفق الذكاء الاصطناعي | استهلاك الأحداث المساعدة واستعادة الجلسات | مفتاح نموذج |
| تأليف البرنامج المساعد | كتابة واختبار البرنامج المساعد | TypeScript |
| تاريخ المشروع | التفرع والالتزام والمراجعة والدمج | مشروع |
| الاقتران رفيق | قم بإقران تطبيق iOS | ايفون |
| استكشاف أخطاء سطح المكتب وإصلاحها | تشخيص مشاكل بدء التشغيل والتحديث | تطبيق سطح المكتب |
| المساهمة | قم بإعداد تغيير قابل للمراجعة | استنساخ |