ساختار مستندات

ساختار فایل‌ها

• index.html — صفحهٔ اصلی مستندات.
• docs/getting-started/ — راه‌اندازی و نمای کلی.
• docs/platform/ — زیرساخت، DevOps و رجیستری.
• docs/operations/ — عملیات انتشار و ایمیج.
• docs/reference/ — مرجع ساختار و نقشهٔ راه.
• assets/css/docs.css — قالب مشترک سایت.
• assets/js/docs.js — رفتار مشترک (تم تیره/روشن، فهرست responsive).
• assets/js/mermaid.min.js — رندر دیاگرام‌ها (محلی، مناسب air-gap).

افزودن راهنمای جدید

1. فایل HTML راهنما را در پوشهٔ موضوعی مناسب زیر docs/ قرار دهید (یا از یک HTML مستقل موجود استفاده کنید).
2. در صورت استفاده از اسکریپت تبدیل، مسیر منبع و مقصد را به build_docs.py اضافه کنید تا در قالب مشترک قرار گیرد.
3. لینک صفحه را به منوی کناری (NAV در اسکریپت یا nav صفحات دستی) و در صورت نیاز به index.html اضافه کنید.
4. محتوای فنی راهنما را تغییر ندهید؛ فقط قالب/سازمان‌دهی یکپارچه شود.

پوشهٔ guides/ شامل فایل‌های HTML خام/قدیمی است و می‌تواند به‌عنوان آرشیو منبع نگه داشته شود؛ نسخهٔ منتشرشدهٔ سایت از index.html و docs/ سرو می‌شود.