ویکی

ویکی فضایی برای مستندسازی مشارکتی در مخزن شما فراهم می‌کند. برای مستندات پروژه، راهنماها و پایگاه‌های دانش عالی است.

ایجاد ویکی

فعال‌سازی ویکی

1. به تنظیمات مخزن بروید
2. در زیر "تنظیمات پیشرفته", مطمئن شوید "فعال‌سازی ویکی" تیک خورده است
3. قابلیت مشاهده ویکی را انتخاب کنید:
   • عمومی: هرکسی می‌تواند ببیند
   • خصوصی: فقط همکاران می‌توانند ببینند

ایجاد صفحه اول

1. به تب ویکی بروید
2. روی "ایجاد صفحه اول" کلیک کنید
3. اضافه کنید:
   • عنوان صفحه: نام صفحه
   • محتوا: در Markdown بنویسید
4. روی "ایجاد" کلیک کنید

ویژگی‌های ویکی

پشتیبانی Markdown

با استفاده از سینتکس Markdown بنویسید:

# Header 1
## Header 2

**متن bold**
*متن italic*

- مورد لیست ۱
- مورد لیست ۲

[متن لینک](https://example.com)

![متن جایگزین تصویر](url-تصویر)

صفحات متعدد

برای موضوعات مختلف صفحات متعدد ایجاد کنید:

• Home - صفحه اصلی ویکی
• شروع سریع - راهنمای راه‌اندازی
• مستندات API - مرجع API
• استقرار - دستورالعمل‌های deploy

سازمان‌دهی صفحات

• نوار کناری: به‌طور خودکار از عناوین صفحات ایجاد می‌شود
• لینک‌های داخلی: لینک بین صفحات ویکی
• بازبینی‌ها: ردیابی تغییرات و مشاهده تاریخچه

مدیریت ویکی

ویرایش صفحات

1. روی دکمه "ویرایش" در هر صفحه کلیک کنید
2. تغییرات خود را اعمال کنید
3. پیام ویرایش اضافه کنید (اختیاری)
4. روی "ذخیره" کلیک کنید

حذف صفحات

1. روی دکمه "حذف" کلیک کنید
2. حذف را تأیید کنید

⚠️ هشدار: صفحات حذف‌شده قابل بازیابی نیستند!

تاریخچه صفحه

تمام بازبینی‌ها را مشاهده کنید:

1. روی "تاریخچه صفحه" کلیک کنید
2. لیست تمام تغییرات را ببینید
3. نسخه‌ها را مقایسه کنید
4. در صورت نیاز به نسخه قبلی برگردید

بهترین شیوه‌ها

• ✅ با یک صفحه Home جامع شروع کنید
• ✅ از عناوین صفحه واضح و توصیفی استفاده کنید
• ✅ محتوا را منطقی سازمان‌دهی کنید
• ✅ در صورت مرتبط بودن مثال‌های کد شامل کنید
• ✅ مستندات را به‌روز نگه دارید
• ✅ از لینک‌های داخلی برای اتصال صفحات مرتبط استفاده کنید
• ✅ برای وضوح تصاویر و نمودارها اضافه کنید

موارد استفاده رایج

مستندات پروژه

• نمای کلی معماری
• دستورالعمل‌های راه‌اندازی
• راهنمای پیکربندی
• مرجع API

پایگاه دانش تیمی

• استانداردهای کدنویسی
• روش‌های استقرار
• راهنماهای عیب‌یابی
• مواد آنبوردینگ

راهنماهای کاربر

• مستندات ویژگی‌ها
• آموزش‌ها
• سوالات متداول
• مثال‌ها

ویکی در مقابل README

مراحل بعدی

• درباره مسائل بیاموزید
• درخواست‌های تغییر را کاوش کنید
• درباره سازمان‌ها بخوانید