مشارکت در مستندات
مستندات نوین کلاود متنباز است. اگر غلط املایی، توضیح نامفهوم، مثال اشتباه یا مطلبی جامانده دیدید، میتوانید خودتان آن را اصلاح کنید — لازم نیست برنامهنویس باشید.
سادهترین راه — ویرایش در مرورگر
۱. به صفحهای که میخواهید اصلاح کنید بروید. ۲. در پایین صفحه روی «ویرایش این صفحه» کلیک کنید. ۳. گیتهاب فایل را باز میکند. روی آیکون مداد (✏️) بزنید. ۴. متن را اصلاح کنید. ۵. پایین صفحه، در کادر توضیح، یک جمله کوتاه درباره تغییرتان بنویسید. ۶. روی Propose changes و سپس Create pull request کلیک کنید.
همین. ما تغییر شما را بررسی میکنیم و پس از تایید، روی سایت منتشر میشود.
ساخت حساب گیتهاب رایگان است و کمتر از یک دقیقه طول میکشد. پس از ساخت حساب، مراحل بالا را دنبال کنید.
برای تغییرات بزرگتر — اجرای محلی
اگر میخواهید چند صفحه را تغییر دهید یا صفحه جدیدی اضافه کنید:
git clone https://github.com/novincloud/docs-novin.git
cd docs-novin
npm install
npm start
سایت روی http://localhost:3000 بالا میآید و با ذخیره هر فایل بلافاصله بهروز میشود.
پیش از ارسال تغییرات، از سالم بودن build مطمئن شوید:
npm run build
چه چیزهایی کمک بزرگی است؟
- اصلاح اشتباهها — هر جا مستندات با رفتار واقعی کنسول فرق دارد
- افزودن مثال — نمونه کد یا سناریوی واقعی
- شفافسازی — جایی که توضیح گنگ است
- تجربه شما — مشکلی که خودتان با آن مواجه شدید و راهحلش
نکات نگارشی
- زبان مستندات فارسی است و جهت متن راستبهچپ.
- اصطلاحات فنی را در صورت لزوم به انگلیسی هم بنویسید: «سرچشمه (Upstream)».
- بلاکهای کد همیشه چپبهراست نمایش داده میشوند — نیازی به تنظیم خاصی نیست.
- بهجای توضیح کلی، مثال واقعی بیاورید.
سوال دارید؟
اگر درباره نحوه مشارکت سوالی دارید، در همان Pull Request بپ رسید یا از تیکت پشتیبانی استفاده کنید.