description
Translated by Robbieshadow

کتاب استارکنت

این مخزن حاوی منبع کتاب استارکنت است.

مشارکت

هر سهمی، صرف نظر از اندازه آن، نقشی اساسی در اصلاح این اثر دارد. ما با هم روایت Starknet را پیش می بریم.

  • دستورالعمل های عمومی:
    • روی پیشرفت هایی که مستقیماً با محتوای کتاب مرتبط است تمرکز کنید.
    • برای اشتباهات تایپی، خطاها یا بهبودها، برای ارسال PR نیازی به مشکل مرتبط ندارید.
    • حوزه های خاص مورد علاقه را در مسائل مخزن مرور کنید.

تنظیمات

  1. بسته های Rust
    • زنجیره ابزار محموله را از طریق Rustup نصب کنید.
    • وmdBook و پسوند ترجمه آن را نصب کنید:
cargo install mdbook --version 0.4.31 && cargo install mdbook-i18n-helpers --version 0.1.0
  1. بسته های ماشینی:
  • برای ترجمه، gettext را نصب کنید: sudo apt install gettext.
  • در مک، می توانید از brew install gettext برای نصب استفاده کنید.
  1. عملیات مخزن:
  • مخزن اصلی را شبیه سازی کنید: git clone https://github.com/starknet-edu/starknetbook && cd starknetbook.
  • یک شاخه در چنگال خود ایجاد کنید و روی آن کار کنید. اگر آشنایی ندارید، از این راهنما برای کمک استفاده کنید.
  • پس از انجام، یک PR برای ادغام ویرایش های خود ارسال کنید. اطمینان حاصل کنید که یک بازبین را برای بازخورد برچسب گذاری کرده اید (l-henri یا @omarespejel).
  1. قالب بندی
  • npm i را اجرا کنید
  • سپس پس از تکمیل مستندات خود فرمت npm را اجرا کنید

درک ساختار کتاب

کتاب Starknet برای mdBook بهینه شده است:

  • src/SUMMARY.md: طرح کلی ساختاری کتاب. برای افزودن فصل، این سند را اصلاح کنید.
  • src/: این دایرکتوری دارای فصول جداگانه است. هر کدام یک فایل علامت گذاری هستند، مانند ch35.md. برای منابع اضافه شده از زیر شاخه ها استفاده کنید.
  • book.toml: فایل پیکربندی اولیه (ممکن است مشارکت‌کنندگان عادی نیازی به تنظیم آن نداشته باشند).

دستورالعمل های ویرایش

به زبان انگلیسی به صورت محلی کار کنید

مطمئن شوید که تمام ویرایش‌های فایل‌های Markdown به زبان انگلیسی هستند.

  • از mdbook serve برای راه اندازی یک سرور محلی استفاده کنید. در localhost:3000 به کتاب دسترسی پیدا کنید یا دستور راه اندازی خودکار مرورگر را به --open اضافه کنید: mdbook serve --open.
  • پس از ویرایش، مرورگر را به‌روزرسانی کنید تا به‌روزرسانی‌ها را ببینید. هنگامی که راضی هستید، تغییرات خود را از طریق روابط عمومی انجام دهید.

ترجمه ها

این کتاب با هدف قرار دادن خوانندگان جهانی، به مرور زمان ترجمه خواهد شد.

  • نسخه اولیه همیشه به زبان انگلیسی: همیشه فایل ها را در فهرست src به زبان انگلیسی بنویسید. این سازگاری امکان ترجمه خودکار روان را فراهم می کند.
  • فرآیند ترجمه:
  • یک سرور محلی برای زبان مورد نظر راه اندازی کنید، به عنوان مثال، ./translations.sh es. بدون تعیین زبان، فقط ترجمه های انگلیسی استخراج می شوند.
  • فایل ترجمه مورد علاقه را مانند po/es.po تغییر دهید. ابزارهایی مانند poedit می توانند مفید باشند.
  • تغییرات را فقط در فایل po/xx.po انجام دهید. هنگام باز کردن یک PR، با پیشوند i18n شروع کنید.

کار ترجمه از مخزن جامع زنگ الهام گرفته شده است.

شروع یک ترجمه جدید

برای شروع ترجمه به زبان جدید:

  • Employ ./translations.sh new xx, replacing xx with your language code. This action generates a language file.
  • برای به روز رسانی فایل xx.po از ./translations.sh xx استفاده کنید.
  • اگر فایل xx.po از قبل وجود دارد از دستور بالا اجتناب کنید (به این معنی که شما ترجمه جدیدی را شروع نمی کنید).