مرجع زنده
هر سند این پوشه دربارهٔ کد امروز حرف میزند و با همان کامیتی عوض میشود که کد
را عوض میکند. اگر چیزی اینجا با کد نمیخواند، اشکال است — نه «قدیمی شده»:
node scripts/doc-claims.mjs هر مسیر، شمارهٔ خط و سقفِ اندازهای را که اینجا نوشته شده با کد میسنجد.
سه سطح، و چه چیزی کجا نوشته میشود
Section titled “سه سطح، و چه چیزی کجا نوشته میشود”| سطح | کجا | زمانِ فعلش | چه چیزی آنجا میرود |
|---|---|---|---|
| مرجع | همین پوشه | حال | کد امروز چطور کار میکند. همکامیت با کد. بی تاریخ، بی «قبلاً» |
| دفترچه | docs/journal/ |
گذشته | هر نسل وقتی تمام شد: چه شد، چه اندازه گرفته شد، چه اشتباه بود |
| نقشه | plan-v6/ (و plan-v5/) |
آینده | چه قرار است بشود، با عددِ پذیرش؛ PROGRESS.md انحرافها را مینویسد |
قاعدهاش یک جمله است: اگر جملهای با «تا فاز ۳ چنین بود» شروع میشود جایش دفترچه است، اگر با «خواهیم کرد» جایش نقشه است، و اگر با «هست» جایش همینجاست. دلیلِ یک تصمیم («چه امتحان شد و نشد») استثناست و کنارِ خودِ کد میماند، نه در سند.
راهنمای کاربر هیچکدامِ این سه نیست: در apps/site/src/content/docs/guide/ نوشته میشود، به
فارسی و انگلیسی، و مخاطبش کارگاه است نه برنامهنویس.
| سند | پاسخ به |
|---|---|
| architecture.md | بستهها، جهت وابستگی، هر ماژول کجاست، چه چیزهایی عمداً نیست |
| pipeline.md | از Project تا لیست برش، چیدمان ورق، هشدار و هزینه — یک مسیر برای رابط، چاپ و خط فرمان |
| data-model.md | مفاهیم و قراردادهای مدل داده؛ قرارداد نوار لبه |
| testing.md | لایههای آزمون، آستانهٔ پوشش، چطور اجرا و چطور اضافه کنیم |
| cli.md | فرمانهای خط فرمان، پرچمها، کد خروج |
| deploy.md | ساخت، CI، انتشار دستی روی GitHub Pages، آزمون سرتاسری |
| darz-format.md | قالب پروندهٔ پروژه — تولیدی از اسکیما |
| rules.md | قواعد دستیار با «چرا» — تولیدی از کد |
| print.md | برگههای چاپی، صفحهبندی، سوراخکاری ۱:۱، QR، DXF، XLSX، بستههای مخاطب |
| workshop.md | حالت کارگاه روی گوشی: تحویل قطعه، اسکن برچسب، مونتاژ، پیشرفت در پروژه، share_target |
| catalog.md | کاتالوگ کاربر، دفترهای قیمت، داشبورد هزینه و اطمینان، «یک ورق کمتر»، گونهها، مرجع از پرونده |
| storage.md | ذخیرهٔ خودکار، دو زبانه، ماندگاری، پروندهٔ .darz، امنیت، مسیرها و پوسته |
| data-layer.md | لایهٔ دادهٔ مرورگر: جدولها، مخزنها، پاکتِ ردیف، ارتقای پایگاه، پشتیبان و دفترِ رویداد |
| editor.md | ویرایشگر دوبعدی: پوسته و چیدمان، ماشین حالت تعامل، چفت، رجیستریِ فرمان و کلیدها، بازرس، پنجرهٔ دوم |
| scene.md | صحنهٔ سهبعدی و رندر: SceneCanvas، حلقهٔ رسم و از دست رفتنِ زمینه، نماها، رندرِ آفلاین، عکسِ دیوار، رگرسیون بصری |
| ui.md | سامانهٔ طراحی (packages/ui): توکنها، نگهبانهای CSS، قراردادِ اجزا، اجزا، Storybook |
| i18n.md | بینالمللیسازی: پیام در هسته، رندر در لبه، جهتِ داده، شبهزبان و جاروی en-US، عدد و تاریخ، افزودن زبان |
| i18n-glossary.md | واژهنامهٔ ترجمه: برابرِ انگلیسیِ اصطلاحهای کابینتسازی، معناهای دیگر، استثنا به شناسهٔ پیام |
| fonts.md | فونت: یکانبخ برای رابط، وزیرمتن برای چاپ، مجوز، ساختِ زیرمجموعه، پوشش نویسه، ارقام همعرض |
| conventions.md | زبانِ هر متن به مخاطبش (کامنت و کامیت انگلیسی؛ رابط و مرجع فارسی)، قالبِ Conventional Commits، نگهبانهایش — انگلیسی |
| traps.md | هر تلهٔ شناختهشده و نگهبانی که امروز میگیردش؛ بینگهبانها در CLAUDE.md هم هستند |
| privacy.md | دادهٔ کارگاه و مشتری کجا میماند، چه چیزی بیرون نمیرود، و چطور پاک میشود |
دو سند از کد تولید میشوند — دستی ویرایششان نکن؛ منبع را عوض کن و دوباره بساز: rules.md (و
rules.en.md) با node scripts/rules-doc.mjs از packages/core/src/validate/rules/، و
darz-format.md با node scripts/darz-format.mjs از packages/core/src/schema/v4.ts؛ pnpm verify
هر دو را با --check میراند.
مرجع یک منبع دارد و آن فارسی است (۹.۱): سایتِ انگلیسی همان صفحه را با اعلانِ «به این زبان نیست» ِ
Starlight نشان میدهد. تنها استثنا rules.en.md است که ساخته میشود و کهنه نمیشود، چون «چرا؟» ِ
دستیارِ انگلیسی باید به متنِ انگلیسی برسد.