نمای کلی شروع
این مخزن چیست؟
Section titled “این مخزن چیست؟”aidin-docs پرتال مستقل انتشار مستندات عمومی آیدین است. این مخزن با Astro Starlight ساخته میشود، محتوای اصلی را بهصورت Markdown/MDX نگه میدارد، و جستوجوی ایستا را با Pagefind فراهم میکند.
جریان کاری محلی
Section titled “جریان کاری محلی”- وابستگیها را با
pnpm installنصب کنید. - محیط توسعه را با
pnpm devاجرا کنید. - پیش از انتشار، اعتبارسنجی کامل را با
pnpm validateاجرا کنید.
جزئیات اجرایی و پیشنیازهای محیطی در README.md مخزن ثبت میشوند.
قواعد محتوایی
Section titled “قواعد محتوایی”- فقط اطلاعات تأییدشده منتشر کنید.
- رفتار آیدین را از رفتار پیشفرض بالادستی جدا کنید.
- مسیرهای API، تنظیمات محصول، قیمت، یا قابلیتها را حدس نزنید.
- برای محتوای اقتباسی از منابع بالادستی، مجوز، انتساب، و تطبیق با آیدین الزامی است.
گام بعدی
Section titled “گام بعدی”برای آشنایی با چیدمان مخزن و قراردادهای آینده، صفحهٔ ساختار مستندات را ببینید.