وثائق Locate الداخلية

ابدأ من هنا: وحدة User Migration (ترحيل المستخدمين) — ما الذي حلّ محل كل واجهة Shukah يستدعيها التطبيق، حقلًا بحقل، وما الذي ما زال ناقصًا.

هذا هو المرجع الهندسي الداخلي: أدلة مكتوبة يدويًا عن قواعد العمل (business rules) وتسليمات العمل بين الفرق (handoffs) والتدفقات (flows)، موجّهة إلى مهندسي الويب والجوال الذين يحتاجون إلى معرفة ما يفعله endpoint دون قراءة الشيفرة المصدرية للخدمة.

ما الموجود هنا

• Modules — مجلد واحد لكل مجال ميزات: صفحة نظرة عامة، وصفحة واحدة لكل مجال.
• Services — وثائق التسليم (handoffs) الخاصة بالخدمات (مجال ميزات system-categories).

أين توجد الحقيقة على مستوى الحقول

أسماء الحقول وأنواعها ورموز الحالة مصدرها شيفرة كل خدمة، وكذلك مواصفة OpenAPI الخاصة بها إن كانت الخدمة تنشر واحدة. تُحفظ ثلاث مواصفات كنسخ لحظية (snapshots) في openapi/*.json في جذر المستودع وتُودَع في المستودع، فيُظهر كل pull request أي تغيير في الواجهات. حدّثها بالأمر التالي. تحتاج اثنتان من الثلاث إلى بيانات اعتماد، وهي موثّقة في ملف README.md في الجذر (تحت عنوان "Refreshing the OpenAPI snapshots"):

npm run openapi:fetch

كان هذا الموقع يعرض تلك النسخ اللحظية في قسم API. أُوقف ذلك بتاريخ 2026-10-01 ليبقى الموقع مركّزًا؛ ما زالت النسخ تُجلب وتُودَع في المستودع. لإعادة عرضها، أعد مدخل الإضافة docusaurus-plugin-openapi-docs والقالب docusaurus-theme-openapi-docs وdocItemComponent في sites/internal/docusaurus.config.ts، إضافةً إلى خطوة التوليد gen-api-docs. يتضمن ملف README.md في الجذر الوصفة الكاملة؛ وحزم الإضافة ما زالت مثبّتة.

أين توجد مواصفات التصميم وخطط التنفيذ

هي تبقى في مستودعات الشيفرة وليس هنا. فالمواصفة أو الخطة تصف تغييرًا واحدًا مرتبطًا بالـ commits التي أنجزته — وهي سجل تاريخي مفيد، لكنها لقطة في زمن مضى. أما مهمة هذا الموقع فعكس ذلك: وصف الحاضر، حتى لا يضطر القارئ إلى معرفة ما إذا كان ما أمامه ما زال صحيحًا. وخلط الأمرين يجعل التمييز بينهما بنظرة واحدة مستحيلًا، لذلك تُترك المواصفات والخطط حيث كُتبت، ولا يربط هذا الموقع إليها إلا عند الحاجة.