---
x-i18n:
    generated_at: "2026-04-29T22:22:40Z"
    model: gpt-5.5
    provider: openai
    source_hash: 8b046833f9a15dc61894ab9e808a09a9fb055ef7ada5c3d4893fbe5f70dec126
    source_path: AGENTS.md
    workflow: 16
---

# راهنمای مستندات

این دایرکتوری مالک نگارش مستندات، قواعد پیوند Mintlify، و خط‌مشی i18n مستندات است.

## قواعد Mintlify

- مستندات روی Mintlify (`https://docs.openclaw.ai`) میزبانی می‌شوند.
- پیوندهای داخلی مستندات در `docs/**/*.md` باید نسبت به ریشه باقی بمانند و پسوند `.md` یا `.mdx` نداشته باشند (نمونه: `[Config](/gateway/configuration)`).
- ارجاع‌های متقاطع بخش‌ها باید از anchor روی مسیرهای نسبت به ریشه استفاده کنند (نمونه: `[Hooks](/gateway/configuration-reference#hooks)`).
- عنوان‌های مستندات باید از خط تیرهٔ بلند و آپاستروف پرهیز کنند، چون تولید anchor در Mintlify در این موارد شکننده است.
- README و دیگر مستنداتی که در GitHub رندر می‌شوند باید URLهای مطلق مستندات را نگه دارند تا پیوندها بیرون از Mintlify هم کار کنند.
- محتوای مستندات باید عمومی بماند: بدون نام دستگاه شخصی، نام میزبان، یا مسیر محلی؛ از جایگزین‌هایی مانند `user@gateway-host` استفاده کنید.

## قواعد محتوای مستندات

- برای مستندات، متن UI، و فهرست‌های انتخاب‌گر، سرویس‌ها/ارائه‌دهندگان را به ترتیب الفبایی مرتب کنید، مگر اینکه بخش به‌طور صریح ترتیب اجرا یا ترتیب تشخیص خودکار را توضیح دهد.
- نام‌گذاری Pluginهای همراه را با قواعد اصطلاح‌شناسی Plugin در سراسر مخزن که در `AGENTS.md` ریشه آمده است، سازگار نگه دارید.

## i18n مستندات

- مستندات زبان‌های دیگر در این مخزن نگهداری نمی‌شوند. خروجی تولیدشدهٔ انتشار در مخزن جداگانهٔ `openclaw/docs` قرار دارد (که اغلب به‌صورت محلی با نام `../openclaw-docs` clone می‌شود).
- اینجا مستندات محلی‌سازی‌شده را زیر `docs/<locale>/**` اضافه یا ویرایش نکنید.
- مستندات انگلیسی در این مخزن به‌همراه فایل‌های glossary را منبع حقیقت بدانید.
- خط لوله: مستندات انگلیسی را اینجا به‌روزرسانی کنید، در صورت نیاز `docs/.i18n/glossary.<locale>.json` را به‌روزرسانی کنید، سپس اجازه دهید همگام‌سازی مخزن انتشار و `scripts/docs-i18n` در `openclaw/docs` اجرا شود.
- پیش از اجرای دوبارهٔ `scripts/docs-i18n`، برای هر اصطلاح فنی جدید، عنوان صفحه، یا برچسب کوتاه ناوبری که باید انگلیسی بماند یا از ترجمهٔ ثابت استفاده کند، مدخل‌های glossary اضافه کنید.
- `pnpm docs:check-i18n-glossary` نگهبان عنوان‌های تغییرکردهٔ مستندات انگلیسی و برچسب‌های کوتاه داخلی مستندات است.
- حافظهٔ ترجمه در فایل‌های تولیدشدهٔ `docs/.i18n/*.tm.jsonl` در مخزن انتشار قرار دارد.
- `docs/.i18n/README.md` را ببینید.
