Locate Internal Docs

Bắt đầu từ đây: module User Migration — cái gì đã thay thế từng API Shukah mà app gọi, theo từng field, và còn thiếu gì.

Đây là tài liệu kỹ thuật nội bộ: các hướng dẫn viết tay về business rule, handoff và flow, dành cho web và mobile engineer cần biết một endpoint làm gì mà không phải đọc source của service.

Có gì ở đây

• Modules — mỗi thư mục là một mảng tính năng: một trang tổng quan cộng với một trang cho từng mảng.
• Services — các handoff cho service (mảng tính năng system-categories).

Field-level truth nằm ở đâu

Tên field, kiểu dữ liệu và status code đến từ code của từng service và, nếu service có công bố, từ OpenAPI spec của nó. Ba spec được snapshot vào openapi/*.json ở gốc repo và được commit, để pull request hiển thị mọi thay đổi API. Làm mới chúng bằng lệnh bên dưới. Hai trong ba spec cần credential, được ghi trong README.md ở gốc repo (mục "Refreshing the OpenAPI snapshots"):

npm run openapi:fetch

Site này từng render các snapshot đó thành mục API. Mục đó đã được tắt vào 2026-10-01 để site tập trung hơn; các snapshot vẫn được fetch và commit. Để render lại, khôi phục entry docusaurus-plugin-openapi-docs, theme docusaurus-theme-openapi-docs và docItemComponent trong sites/internal/docusaurus.config.ts, cùng bước sinh gen-api-docs. README.md ở gốc repo có công thức đầy đủ; các package của plugin vẫn còn được cài.

Design spec và implementation plan nằm ở đâu

Chúng vẫn ở trong các code repo, không nằm ở đây. Một spec hay một plan mô tả một thay đổi, gắn với các commit đã tạo ra nó — là lịch sử hữu ích, nhưng chỉ là ảnh chụp tại một thời điểm. Việc của site này ngược lại: mô tả hiện tại, để người đọc không phải tự suy xem thứ mình đang xem còn đúng hay không. Trộn hai thứ sẽ khiến điều đó không thể nhận ra ngay, nên spec và plan được để nguyên nơi chúng được viết và site này chỉ link tới khi cần.