Работа с документацией

Этот раздел, посвящен работе с нашей документацией! Здесь вы узнаете, как вы можете внести свой вклад в улучшение и обновление материалов.

Какой путь выбрать?

Перед тем как начать, определите, какой способ редактирования документации подходит именно вам:

• Для пользователей: если вы хотите вносить изменения непосредственно через веб-интерфейс GitHub, без установки дополнительного программного обеспечения. Этот метод прост и не требует специальных навыков.

• Для разработчиков: если вы предпочитаете работать с локальной копией проекта, используя инструменты разработчика, и готовы создавать коммиты и работать с Git. Этот способ подходит для более крупных изменений и требует базовых знаний Git и командной строки.

Общие инструкции для всех

Независимо от выбранного вами пути, следующие ресурсы будут полезны:

1. Основы Markdown

Наша документация написана с использованием Markdown — простого и удобного языка разметки. Если вы не знакомы с ним, рекомендуем ознакомиться с руководством по Markdown, чтобы узнать, как форматировать текст, создавать списки, добавлять ссылки и изображения.

2. Стандарты оформления

Для поддержания единообразия и высокого качества документации, пожалуйста, следуйте нашим стандартам оформления. Здесь вы найдете рекомендации по структуре документов, стилю написания и форматированию.

Продолжайте и выберите подходящее руководство, чтобы начать свой вклад в нашу документацию!