WIP Editing

ReadMe.md

@@ -50,7 +50,7 @@
 ۵. پس از پایان کار، برنامه باید [کاربر را به دیوار برگرداند][راهنما » مدیریت اپ »‌ تعامل در آگهی]. \
 ۶. پس از انتشار، کاربران آگهی‌بیننده می‌توانند با محتوای درج‌شده تعامل داشته‌باشند (برای مثال، با استفاده از دکمه‌های اضافه شده، آدرس‌های مشخص شده در برنامهٔ شما را باز کرده و با وب‌اپلیکیشن شما تعامل کنند). دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را [به دیوار بازگردانید][راهنما » مدیریت اپ »‌ تعامل در آگهی].
 
-<img src="img/post-flow.png" alt="مسیر ارائهٔ خدمات در آگهی"/>
+![مسیر ارائهٔ خدمات در آگهی](img/post-flow.png)
 
 <br>
 
@@ -83,8 +83,8 @@
 ۵. شما می‌توانید به پیام‌های ارسالی در مکالمه، دکمه‌هایی برای طرفین مکالمه ضمیمه کنید که کاربران با استفاده از آن‌ها، [با برنامهٔ شما تعامل نمایند][راهنما » افزونه‌های چت » ارسال پیام‌ » دکمه].\
 ۶. بعد از پایان تعامل، برنامهٔ شما باید کاربر را [به دیوار برگرداند][راهنما » مدیریت اپ »‌ تعامل در چت].
 
-<img src="img/chat-flow.png" alt="مسیر ارائهٔ خدمات در چت"/>
 
+![مسیر ارائهٔ خدمات در چت](img/chat-flow.png)
 <br>
 
 > 💡 ***مثال*** \

management/ReadMe.md

@@ -1,8 +1,8 @@
 <br><br>
 
 # مدیریت اپلیکیشن‌ها
-
-خدمات ارائه شده در **کنار دیوار**، در قالب «اپلیکیشن» (برنامه، Application، App) به کاربرها ارائه می‌شوند. هر اپلیکیشن دارای پارامترهای مختلفی‌ست که بر مبنای آن‌ها، نحوه‌ی معرفی اپلیکیشن به کاربرها در دیوار، نحوه‌ی تعامل سرویس‌های دیوار با اپلیکیشن، امکانات در دسترس اپلیکیشن و ... تعیین می‌شوند.
+کاربران برنامه‌های خدمت‌دهنده در کنار دیوار را با نام افزونه یا مکمل می‌بینند. هر کدام از افزونه‌ها یا مکمل‌ها باید در قالب یک «اپلیکیشن» (Application, App, برنامه) در پنل کنار دیوار ثبت شده و مدیریت شوند.\
+هر اپلیکیشن دارای پارامترهای مختلفی‌ست که بر مبنای آن‌ها، نحوهٔ معرفی اپلیکیشن به کاربرها در دیوار، نحوهٔ تعامل سرویس‌های دیوار با اپلیکیشن، امکانات در دسترس اپلیکیشن و ... تعیین می‌شوند.
 
 <br>
 
@@ -20,11 +20,11 @@
 
 <br>
 
-## شناسه‌ی اپلیکیشن (Slug)
+## شناسهٔ اپلیکیشن (Slug)
 
-هر اپلیکیشن شناسه‌ی یکتایی دارد که در تعاملات مختلف با سرویس‌های دیوار، مثلا در [فرآیند احراز باز][راهنما » احراز باز]، استفاده می‌شود. این شناسه برای هر اپلیکیشن در زمان ساخت تعیین می‌شود و بعد از ساخت اپلیکیشن قابل تغییر نیست.
+هر اپلیکیشن شناسهٔ یکتایی دارد که در تعاملات مختلف با سرویس‌های دیوار، مثلا در [فرآیند احراز باز][راهنما » احراز باز]، استفاده می‌شود. این شناسه برای هر اپلیکیشن در زمان ساخت تعیین می‌شود و بعد از ساخت اپلیکیشن قابل تغییر نیست.
 
-👈 برای مشاهده‌ی این شناسه، [مدیریت‌اپ‌ها در پنل کنار][پنل کنار » اپ‌ها] را باز کرده و فیلد `slug` را بخوانید.
+👈 برای مشاهدهٔ این شناسه، [مدیریت‌اپ‌ها در پنل کنار][پنل کنار » اپ‌ها] را باز کرده و فیلد `slug` را بخوانید.
 
 <br>
 
@@ -33,23 +33,23 @@
 
 <div align="center">
 
-![manage-page](https://github.com/divar-ir/kenar-docs/assets/13572283/73d150c1-d5d8-457e-a405-e105011d5865)
+![نمای یک اپلیکیشن در زمان معرفی به کاربر](/img/app-in-list.png)
 
 </div>
 
-- فیلد عنوان (Display) در همه‌ی نقاط تعامل با کاربرهای دیوار به کار خواهد رفت. علاوه بر محل‌های معرفی اپلیکیشن‌ها، عنوان اپلیکیشن روی افزونه‌های مندرج بر آگهی‌ها یا پیام‌های ارسالی در چت نیز نمایش داده می‌شود.
-- لوگوی اپلیکیشن (Avatar) نیز در خیلی از نقاط تعامل با کاربرها استفاده می‌شود. مطمئن شوید لوگوی شما در ابعاد کوچک نیز به خوبی دیده شده و توسط کاربران شناخته می‌شود.
-- توضیحات (Description) در نقاط معرفی اپلیکیشن شما به کاربرها استفاده می‌شود. سعی کنید توضیحات را تا جای ممکن کوتاه و خلاصه نگه دارید. در صورت دریافت هزینه از کاربرها در ازای خدمات، حتما در این فیلد به شکل شفاف برای کاربرها توضیح دهید. 
+- فیلد عنوان (Display) در همهٔ نقاط تعامل با کاربرهای دیوار به کار خواهد رفت. علاوه بر محل‌های معرفی اپلیکیشن‌ها، عنوان اپلیکیشن روی افزونه‌های مندرج بر آگهی‌ها یا پیام‌های ارسالی در چت نیز نمایش داده می‌شود.
+- لوگوی اپلیکیشن (Avatar) نیز در خیلی از نقاط تعامل با کاربرها استفاده می‌شود. مطمئن شوید لوگوی شما در یک کادر مربع محاط شده‌باشد و نسبت ابعاد فایل تصویر آن ۱:۱ باشد و همچنین در ابعاد کوچک به خوبی دیده و شناسایی شود.
+- توضیحات (Description) نیز در بعضی از نقاط معرفی اپلیکیشن شما به کاربرها نمایش داده می‌شود. سعی کنید توضیحات را تا جای ممکن کوتاه و خلاصه نگه دارید. در صورت دریافت هزینه از کاربرها در ازای خدمات، حتما در این فیلد به شکل شفاف برای کاربرها توضیح دهید. 
 
 <br>
 
 ## تعامل با کاربرها
-کاربرهای دیوار برای تعامل با برنامه‌ی شما، به رابط کاربری وب‌بیسد شما هدایت می‌شوند. مکانیزم انتقال در نقاط تعامل مختلف متفاوت است، اما به طور کلی آدرسی از اپلیکیشن شما دریافت شده، و سپس بسته به پلتفرم کاربر (وب، اندروید، آی‌اوس) کاربر به وب‌ویو یا پاپ‌آپی با آدرس دریافت شده هدایت می‌شود. در طی این فرآیند، اطلاعات اولیه‌ای مانند شناسه‌ی آگهی، شناسه‌ی کاربر تعامل کننده، یا ... نیز در اختیار اپلیکیشن شما قرار می‌گیرد.
+کاربرهای دیوار برای تعامل با برنامهٔ شما، به رابط کاربری تحت وب شما هدایت می‌شوند. مکانیزم انتقال در نقاط تعامل مختلف متفاوت است، اما به طور کلی آدرسی از اپلیکیشن شما دریافت شده، و سپس بسته به پلتفرم کاربر (وب، اندروید، آی‌اوس) کاربر به وب‌ویو یا پاپ‌آپی با آدرس دریافت شده هدایت می‌شود. در طی این فرآیند، اطلاعات اولیه‌ای مانند شناسهٔ آگهی، شناسهٔ کاربر تعامل کننده، یا ... نیز در اختیار اپلیکیشن شما قرار می‌گیرد.
 
 <br>
 
 ### تعامل با کاربر پس از ثبت آگهی
-پس از ثبت آگهی‌های مرتبط، اپلیکیشن شما به کاربرها معرفی می‌شوند. در صورت انتخاب کاربر، آدرس مشخص شده در پارامتر `Fallback URL` برنامه‌ی شما برای کاربر باز می‌شود. درخواست ارسالی به `Fallback URL` به شکل زیر است:
+پس از ثبت آگهی‌های مرتبط، اپلیکیشن شما به کاربرها معرفی می‌شوند. در صورت انتخاب کاربر، آدرس مشخص شده در پارامتر `Fallback URL` برنامهٔ شما برای کاربر باز می‌شود. درخواست ارسالی به `Fallback URL` به شکل زیر است:
 
 ```url
 https://your.app.ir
@@ -60,8 +60,8 @@ https://your.app.ir
   &city=<post-city>
   &...
 ```
-- پارامتر `app_slug` شناسه‌ی برنامه‌ی شماست.
-- پارامتر `post_token` شناسه‌ی آگهی مربوطه‌ست.
+- پارامتر `app_slug` شناسهٔ برنامهٔ شماست.
+- پارامتر `post_token` شناسهٔ آگهی مربوطه‌ست.
   - با کمک این شناسه، می‌توانید [اطلاعات آگهی را از دیوار دریافت کنید][راهنما » اطلاعات آگهی].
   - برای [دریافت اجازه‌های مربوط به این آگهی][راهنما » احراز باز]، از این شناسه استفاده کنید.
   - برای استفاده از قابلیت‌های مرتبط با این آگهی (مثل [اضافه کردن افزونه به آگهی][راهنما » ساخت افزونه]) نیز از این شناسه استفاده کنید.
@@ -94,12 +94,12 @@ authorization: {{ Divar Identification Key }}
   ...
 }
 ```
-- پارامتر `post_token` شناسه‌ی آگهی‌ مربوطه‌ست (برای اطلاعات بیشتر [قسمت قبل را بخوانید][آگهی]).
-- پارامتر `user_id` شناسه‌ی کاربریست که با اپلیکیشن تعامل کرده.
-- پارامتر `peer_id` شناسه‌ی طرف دیگر مکالمه است.
-  - برای [دریافت اجازه‌ها][راهنما » احراز باز] یا [استتفاده از قابلیت‌های مربوط به مکالمه][راهنما » چت]، هر سه‌ی این پارامترها را ارائه کنید. 
+- پارامتر `post_token` شناسهٔ آگهی‌ مربوطه‌ست (برای اطلاعات بیشتر [قسمت قبل را بخوانید][آگهی]).
+- پارامتر `user_id` شناسهٔ کاربریست که با اپلیکیشن تعامل کرده.
+- پارامتر `peer_id` شناسهٔ طرف دیگر مکالمه است.
+  - برای [دریافت اجازه‌ها][راهنما » احراز باز] یا [استتفاده از قابلیت‌های مربوط به مکالمه][راهنما » چت]، هر سهٔ این پارامترها را ارائه کنید. 
 - پارامتر `callback_url` ادرسی‌ست که باید کاربر را بعد از اتمام فرآیند به آن هدایت کنید.
-- مقدار `authorization` معادل پارامتر `Divar Identification Key`، که در سطح اپلیکیشن قابل تنظیم است، قرار داده خواهد شد. با خواندن این هدر و مقایسه‌ی آن، می‌توانید منبع درخواست را احراز کرده مطمئن شوید درخواست از جانب دیوار ارسال شده است. 
+- مقدار `authorization` معادل پارامتر `Divar Identification Key`، که در سطح اپلیکیشن قابل تنظیم است، قرار داده خواهد شد. با خواندن این هدر و مقایسهٔ آن، می‌توانید منبع درخواست را احراز کرده مطمئن شوید درخواست از جانب دیوار ارسال شده است. 
 
 
 <br>
@@ -120,17 +120,17 @@ authorization: {{ Divar Identification Key }}
 
 علاوه بر تعامل با کاربرها، اپلیکیشن شما نیاز به تعامل با دیوار، مثلا برای [دریافت اطلاعات بیشتر در مورد آگهی][راهنما » اطلاعات آگهی]، [افزودن محتوا به آگهی][راهنما » ساخت افزونه]، [ارسال پیام در چت][راهنما »‌ ارسال پیام]، ... نیز دارد. این تعاملات از طریق فراخوانی APIهای **کنار دیوار**، احراز با [کلیدهای API][راهنما » کلیدها]، و در صورت نیاز، [دریافت اجازه از کاربرها][راهنما » احراز باز] صورت می‌گیرد.
 
-گستره‌ی امکانات قابل استفاده در سطح اپلیکیشن تنظیم می‌شود:
+گسترهٔ امکانات قابل استفاده در سطح اپلیکیشن تنظیم می‌شود:
 - پارامتر `Permissions` دسترسی‌های کلی اپلیکیشن (حداکثر دسترسی کلیدها) را مشخص می‌کند.
 - پارامتر `Widgets` المان‌های محتوایی قابل استفاده در آگهی‌ها را مشخص می‌کند.
 
 👈 در صورتی که به استفاده از قابلیت یا المانی نیاز دارید ولی دسترسی به آن را ندارید، با ما تماس بگیرید.
 
 <br>
 
-## مدیریت کاربرها
+## مدیریت کاربران پنل کنار
 
-در [پنل کنار][پنل کنار]، چند کاربر می‌توانند به یک اپلیکیشن خاص دسترسی داشته باشند و بر روی آن کار کنند. پارامتر `Users` تعیین کننده‌ی این دسترسی‌هاست. برای تنظیم دسترسی کاربرهای مختلف به اپلیکیشن خود با ما تماس بگیرید.
+در [پنل توسعه‌دهندگان کنار][پنل کنار]، چند کاربر می‌توانند به یک اپلیکیشن خاص دسترسی داشته باشند و بر روی آن کار کنند. پارامتر `Users` تعیین کنندهٔ این دسترسی‌هاست. برای تنظیم دسترسی کاربرهای مختلف به اپلیکیشن خود با ما تماس بگیرید.
 
 <br>
 
@@ -140,7 +140,7 @@ authorization: {{ Divar Identification Key }}
 
 | پارامتر | توضیحات |
 | - | - |
-| `Slug` | [شناسه‌ی یکتای اپلیکیشن][شناسه] |
+| `Slug` | [شناسهٔ یکتای اپلیکیشن][شناسه] |
 | `Display` | [عنوان اپلیکیشن][نما] |
 | `Avatar` | [تصویر اپلیکیشن][نما] |
 | `Description` | [توضیحات اپلیکیشن][نما] |

management/api-keys.md

@@ -2,7 +2,7 @@
 
 # کلیدهای API
 
-هر درخواستی که از یک اپلیکیشن به سرورهای دیوار زده می‌شود می‌بایست شامل رشته (string) مشخصی به نام «کلید API» یا «API Key» باشد. سرورهای دیوار از طریق این کلید می‌فهمند درخواست از جانب کدام اپلیکیشن ایجاد شده است. درخواست‌های بدون کلید رد خواهند شد.
+هر درخواستی که از یک اپلیکیشن به سرورهای دیوار زده می‌شود می‌بایست شامل رشته (string) مشخصی به نام «کلید API» یا «API Key» باشد. سرورهای دیوار از طریق این کلید می‌فهمند درخواست از سمت کدام اپلیکیشن ارسال شده‌است. درخواست‌های بدون کلید رد خواهند شد.
 
 👈 کلید API را در هدر `x-api-key` درخواست‌های خود قرار دهید: