Редактирует документацию в согласии с новой структурой материалов (do…

…ka-guide#1045)

* Редактирует документацию в согласии с новой структурой материалов

* Apply suggestions from code review

Co-authored-by: Vadim Makeev <[email protected]>

Co-authored-by: Vadim Makeev <[email protected]>

README.md

@@ -40,9 +40,9 @@
 
 1. Клонируйте к себе [репозиторий с контентом](https://github.com/doka-guide/content).
 1. Определитесь с форматом материала (дока или статья) и в соответствующем разделе (html, js, css, tools) создайте новую папку с названием статьи.
-1. Создайте в ней файл `index.md` по шаблону: [дока](docs/examples/doka.md) или [статья](docs/examples/article.md).
+1. Создайте в ней файл _index.md_ по шаблону: [дока](docs/examples/doka.md) или [статья](docs/examples/article.md).
 1. Напишите статью (не забывайте сверяться с руководствами 👆). Всё, что хорошо выглядит в маркдауне, будет хорошо выглядеть на сайте. Если вы хотите предпросматривать статью локально, почитайте [инструкцию по предпросмотру](docs/preview.md).
-1. Дополнительные материалы: картинки, демки, блок «В работе» сохраняйте в ту же папку, в подпапки `images`, `demos`, `practice` и так далее.
+1. Дополнительные материалы: картинки, демки, блок «В работе» сохраняйте в ту же папку, в подпапки _images_, _demos_, _practice_ и так далее.
 1. Запустите автоматическую проверку орфографии командой `npx yaspeller **/*.{md,html}` (вы можете отредактировать это выражение, чтобы протестировать только те файлы, которые вы меняли).
 1. Закончили? Создайте пул-реквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки!
 

docs/contributing.md

@@ -33,20 +33,20 @@
 
 Чтобы добавить или изменить материал, следуйте процессу:
 
-0. Создайте Fork от репозитория и клонируйте его себе на компьютер
+1. Создайте Fork от репозитория и клонируйте его себе на компьютер.
 1. Создайте новую ветку от `main`. Назовите ветку по правилам:
    * новая статья — `tech/название-статьи`, где `tech` это раздел
    * доработки — `update/название-статьи`
    * редакторские правки — `editor/название-статьи`
    * исправления — `fix/...`
-2. Внесите изменения
-3. Сделайте пуш ветки
-4. Создайте Pull Request. Дождитесь проверки и внесите исправления, если потребуется
+1. Внесите изменения.
+1. Сделайте пуш ветки.
+1. Создайте Pull Request. Дождитесь проверки и внесите исправления, если потребуется.
 
 
 ### Дизайн
 
-Если статья принята, она направляется команде дизайнеров, которые готовят иллюстрации, схемы и оформление для примеров кода. Параллельно с этим она проверяется редактором и публикуется на GitHub.
+Если статья принята, она направляется команде дизайнеров, которые готовят иллюстрации, схемы и оформление для примеров кода. Параллельно с этим статья публикуется на GitHub и впоследствии проверяется редактором.
 
 ## Как работает Дока
 
@@ -96,6 +96,8 @@ cover:
   desktop: images/desktop.png <!-- адрес широкой картинки для десктопной обложки -->
   mobile: images/mobile.png <!-- адрес узкой картинки для мобильной обложки -->
   alt: 'Умная собака подозрительно смотрит' <!-- альтернативное описание для обложки -->
+tags:
+  - article <!-- тип материала: article или doka -->
 ---
 
 <!-- далее обычная статья в markdown -->
@@ -110,8 +112,8 @@ cover:
 
 Какого-то из полей в шапке может не хватать, потому что оно пока не используется. Если поле пустое: мы его не пишем, если нужно добавить новое, добавляем.
 
-- [Посмотрите пример статьи для справочника в файле](./examples/doka.md)
-- [Посмотрите пример статьи-лонгрида в файле](./examples/article.md)
+- [Посмотрите пример доки](./examples/doka.md)
+- [Посмотрите пример статьи](./examples/article.md)
 
 #### Как пользоваться полями
 
@@ -131,7 +133,7 @@ cover:
 
 Также в статье используется ссылка на авторов раздела «В работе» и подписи статьи:
 
-Создайте папку `practices`, если её ещё нет, и положите туда файл с вашим ником на гитхабе. Например `solarrust.md`.
+Создайте папку _practice_, если её ещё нет, и положите туда файл с вашим ником на гитхабе. Например _solarrust.md_.
 
 Файл должен начинаться с такой шапки:
 
@@ -155,5 +157,4 @@ permalink: false
 
 Визуально такие демки — интерактивная часть в стандартной вёрстке, не выделенная явно. Это главное отличие инлайновых демок от интеграций с CodePen.
 
-
 Подробнее про демки читайте [в отдельном документе](demos.md).

docs/examples/article.md

@@ -2,6 +2,8 @@
 
 **Статья** — это расширенный материал, посвящённый определённому вопросу, с авторским мнением, примерами и рассуждениями. Например, «Руководство по флексбоксам» не только познакомит вас со спецификацией флексбокса, но и расскажет о раскладке в целом, научит делать её при помощи флексбоксов и покажет примеры из жизни — для этого у нас есть специальный раздел «В работе», где разработчики делятся своим личным опытом по теме.
 
+Мы помечаем статью тегом _article_ в шапке.
+
 Структура статьи примерно такова:
 
 ## Шапка
@@ -15,14 +17,16 @@ title: Название статьи
 authors:
   - Никнейм основного автора
 contributors:
-  - Никнеймы всех соавторов и контрибуторов
+  - Никнеймы всех соавторов и контрибьюторов
 designers: Никнейм дизайнера
 summary:
   - Альтернативные теги для работы поиска
 cover:
   desktop: 'images/desktop.png'
   mobile: 'images/mobile.png'
   alt: 'Альтернативное описание для обложки'
+tags:
+  - article
 ---
 ```
 
@@ -75,7 +79,7 @@ cover:
 
 ## В работе
 
-Мнения разработчиков по теме, рецепты и лайфхаки. Создайте в папке статьи подпапку practice, а в ней файл, поименованный вашим ником.
+Мнения разработчиков по теме, рецепты и лайфхаки. Создайте в папке статьи подпапку _practice_, а в ней файл, поименованный вашим ником.
 
 <details>
   <summary>Пример</summary>

docs/examples/doka.md

@@ -2,6 +2,8 @@
 
 **Дока** — это справочный материал, кратко и формально описывающий некое понятие, например, свойство или тег. Как спецификация, только по-русски и понятным языком.
 
+Мы помечаем доку тегом _doka_ в шапке.
+
 Структура доки примерно такова:
 
 ## Шапка
@@ -15,22 +17,24 @@ title: Название статьи
 authors:
   - Никнейм основного автора
 contributors:
-  - Никнеймы всех соавторов и контрибуторов
+  - Никнеймы всех соавторов и контрибьюторов
 designers: Никнейм дизайнера
 summary:
   - Альтернативные теги для работы поиска
 cover:
   desktop: 'images/desktop.png'
   mobile: 'images/mobile.png'
   alt: 'Альтернативное описание для обложки'
+tags:
+  - doka
 ---
 ```
 
 </details>
 
 ## Кратко
 
-Кратко даём основное определение элемента.
+Кратко даём основное определение.
 
 ## Пример
 
@@ -57,16 +61,16 @@ CSS
 
 ## Как это понять
 
-Объясняем, как лучше понять это свойство и в чем его нюансы.
+Объясняем, как лучше понять этот термин, и в чём его нюансы.
 
 ## Как пишется
 
 Рассказываем о синтаксисе.
 
 ## Подсказки
 
-💡 Делимся лайфхаками, которые помогают понять те или иные нюансы синтаксиса.
+💡 Делимся лайфхаками, которые помогают понять те или иные нюансы.
 
 ## В работе
 
-Рассказываем, как не сесть в лужу, если используешь этот элемент в работе. Создайте в папке статьи подпапку practice, а в ней файл, поименованный вашим ником.
+Рассказываем, как не сесть в лужу, если используешь этот элемент в работе. Создайте в папке статьи подпапку _practice_, а в ней файл, поименованный вашим ником.

docs/typography.md

@@ -25,11 +25,11 @@
 
 1. Для выделения **жирным** используйте две звёздочки: `**болд**`, а для _курсива_ — одно нижнее подчёркивание: `_италик_`.
 
-1. Выделяйте код и цифровые значения в тексте при помощи обратных апострофов (бэктиков):
+1. Выделяйте код в тексте при помощи обратных апострофов (бэктиков):
 
     ⛔ По умолчанию значение свойства order равно 0.
 
-    ✅ По умолчанию значение свойства `order` равно `0`.
+    ✅ По умолчанию значение свойства `order` равно 0.
 
     Блоки кода выделяются при помощи трёх бэктиков с указанием нужного языка: