Skip to Content
⚠ Документация в разработке
СоглашенияДокументация

Соглашение об едином стиле в документации

Есть ряд правил, которые желательно соблюдать:

  1. MD и MDX файлы обязаны быть сжаты до удобного для чтения с любого экрана монитора по ширине строки (в символах). Рекомендуемая длина символов — максимум 70. Ссылки также желательно выносить на отдельную строку, если они чересчур сильно превышают рекомендуемый размер.
  2. Блоки кода на странице должны быть приведены к соглашению команды об общем стиле кодовой базы. Исключением является то, когда вы явно указываете на то, что так делать нельзя (таковое может быть, когда вы предоставляете пример с намеренно написанным кодом, содержащим ошибки).
  3. У всего должно быть место: архитектура, соглашения, проекты, примеры — для всего этого есть специализированные папки. Старайтесь писать так, чтобы потом это было удобно и читать, и писать.
  4. За книгами должно быть указано оригинальное авторство. Также рекомендуется указывать в сайдбаре и заголовке страницы автора плюс название материала (книги). Пример: Автор — Название книги.
  5. Перед критически важными изменениями открывать PR или заранее обговаривать с командой эти изменения.
Last updated on