תיעוד טכני

עמוד התיעוד הטכני עוד רגע כאן.

כרגע `/docs` הוא עמוד mock מכוון. המשטח הסופי יישאר צר וטכני: חוזי API, auth, deploy, אינטגרציות וארכיטקטורת פלטפורמה.

חומר לא טכני בכוונה מחוץ לתחום כאן. הנתיב הזה שמור לפרטי יישום בלבד.

סעיפים מתוכננים

עמוד mock שמצביע רק לכיוון תוכן טכני

שום דבר כאן לא מתיימר להיות אינדקס תיעוד מלא. זה placeholder נקי שמסמן איפה התיעוד ההנדסי האמיתי ינחת.

01

פירוט endpoint-level של בקשות ותגובות, חוקי validation ומקרי כשל נפוצים.

02

התנהגות auth מודעת-tenant, דפוסי גישה, סודות וגבולות הרשאה.

03

Webhooks, channels, חוזים מול מערכות חיצוניות ומקרי קצה תפעוליים.

04

הגדרת סביבה, ציפיות runtime של queues, צעדי שחרור ו-smoke tests.

שפת התיעוד

התיעוד הסופי צריך להעדיף פקודות, payloads וציפיות תפעוליות במקום סיפור מוצר רחב.

מה אמור להופיע כאן

הדוגמאות צריכות להישאר קונקרטיות. להראות את הפקודה, החוזה, הקונפיגורציה או הכלל התפעולי.

pnpm dev
pnpm --filter @cs/api test
pnpm build

צעדי setup ואימות בגישת command-first.

דוגמאות request ו-response כשהחוזה חשוב.

משתני סביבה, queues והתנהגות workers.

הערות ארכיטקטורה רק כשהן פותחות חסימת יישום.

טכני בלבד

מעטפת ה-UI כבר קיימת. בסבב הבא אפשר להחליף את ה-placeholder blocks ברפרנסים הטכניים בפועל.