مستندات پروژه خورشید
به پلنت خوش آمدید
به پروژه بزرگ خورشید خوش آمدید! این مستندات شما را در اکوسیستم جامع پلتفرم ما راهنمایی خواهد کرد.
ما یک پلتفرم جامع به نام سیاره داریم که یک سیستم کامل برای راهاندازی وبسایتها با ویژگیهای گسترده است. این پلتفرم از دو بخش اصلی تشکیل شده است:
- خورشید: سرور API اصلی که تمام کلاینتها را تغذیه میکند. به عبارت دیگر، خورشید قلب تپنده پلتفرم است.
- مشتری: به کلاینتها و مشتریان ما اشاره دارد که به خدمات خورشید متکی هستند.
شما وارد منطقه مستندات میشوید 🚀 ممکن است باعث اضافه بار مغزی شود 🧠💥
شروع به کار
- توسعهدهندگان جدید
- اعضای تیم فعلی
- مشارکتکنندگان
اگر با پروژه پلنت آشنا نیستید، توصیه میکنیم با موارد زیر شروع کنید:
- سند نیازمندیها را مطالعه کنید
- محیط داکر خود را راهاندازی کنید
- راهاندازی پروژه را تکمیل کنید
- دستورالعملهای توسعه ما را مرور کنید
اگر قبلاً با پروژه پلنت آشنا هستید:
- بهروزرسانیهای اخیر پلتفرم را بررسی کنید
- مستندات API را برای هرگونه تغییر مرور کنید
- ویژگیهای پیشرفته که ممکن است استفاده نکرده باشید را بررسی کنید
اگر میخواهید در پروژه پلنت مشارکت کنید:
- با استانداردهای کدنویسی ما آشنا شوید
- گردش کار گیتهاب را مرور کنید
- مسائل باز ما را بررسی کنید
نمای کلی پروژه
این سایت مستندات، اطلاعات جامعی درباره API خورشید و خدمات مرتبط ارائه میدهد. محتوا به گونهای سازماندهی شده است که به توسعهدهندگان کمک کند تا به سرعت اطلاعات مورد نیاز خود را برای کار مؤثر در پروژه سیاره پیدا کنند.
از منوی کناری برای مرور بخشهای مختلف استفاده کنید، یا از قابلیت جستجو در بالای صفحه برای یافتن سریع اطلاعات خاص استفاده کنید.
نحوه استفاده از این مستندات
این مستندات به گونهای ساختاربندی شدهاند که شما را در جنبههای مختلف API خورشید راهنمایی کنند:
| بخش | توضیحات | برای چه کسانی |
|---|---|---|
| مبانی API | مفاهیم اصلی، ساختار URL و الگوهای رایج | همه توسعهدهندگان |
| API مدیریت | مستندات برای نقاط پایانی و ویژگیهای مدیریتی | توسعهدهندگان بکاند، مدیران |
| API کلاینت | مستندات برای نقاط پایانی و ویژگیهای مرتبط با کلاینت | توسعهدهندگان فرانتاند، کاربران API |
| توسعه | دستورالعملهایی برای مشارکت در کد | مشارکتکنندگان |
| آموزشها | راهنماهای گام به گام برای کارهای رایج | توسعهدهندگان جدید |
مشارکت در مستندات
ما از مشارکتها برای بهبود این مستندات استقبال میکنیم. برای مشارکت:
- مخزن گیتهاب را فورک کنید
- تغییرات خود را با پیروی از استانداردهای مستندات ما اعمال کنید
- یک درخواست کشش با توضیح واضحی از بهبودهای خود ارسال کنید
هنگام مشارکت در مستندات، لطفاً این دستورالعملها را دنبال کنید:
- از زبان واضح و مختصر استفاده کنید
- در صورت لزوم، مثالهای کد را اضافه کنید
- برای ویژگیهای مرتبط با رابط کاربری، تصاویر اضافه کنید
- قبل از ارسال، تمام مثالهای کد را آزمایش کنید
پشتیبانی و جامعه
اگر به کمک نیاز دارید یا سؤالاتی درباره پروژه پلنت دارید:
- به جامعه دیسکورد ما بپیوندید
- بخش سؤالات متداول را بررسی کنید
- یک مسئله در گیتهاب ارسال کنید
از اینکه بخشی از جامعه پروژه پلنت هستید، متشکریم!