Доработка главного ридми. 2 итерация #5458
Conversation
solarrust
added
улучшение
solarrust
requested review from
HellSquirrel,
igsekor,
TatianaFokina,
skorobaeus and
furtivite
Превью контента из 2d414c9 опубликовано. |
|
|
||
| [Документация](docs/README.md) | ||
| > Подробная [**👉Документация👈**](docs/README.md) на случай, если хочется узнать больше про возможности Доки в плане контента. Например, посмотреть на дизайн-систему или создать свой профиль автора. |
There was a problem hiding this comment.
Подробная 👉Документация👈 на случай, если ...
Мне кажется не стоит указывать причину по которой Документация может понадобиться )
Что если, кратким списком ссылок перечислить какие вопросы в документации подробно рассмотрены (разделы доки, стиль и тд.) ?
| 1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. | ||
| 1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. ([Как создать пулреквест?](https://doka.guide/recipes/github-new-pull-request/)) | ||
|
|
||
| Если в процессе возникли вопросы, то их можно задать в [чате Доки](https://t.me/+qYFPI2mExuQxZTFi). |
There was a problem hiding this comment.
Предлагаю перенести в самый низ и переформулировать, что-то типа:
Остались вопросы? Приходите в чат Доки
| 1. Работайте над материалом. | ||
| 1. В процессе работы делайте коммиты. | ||
| 1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. | ||
| 1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. ([Как создать пулреквест?](https://doka.guide/recipes/github-new-pull-request/)) |
There was a problem hiding this comment.
Не думаю, что новичок готовится к ревью, он может подумать что ревью это какое-то собеседование )
п. 5 в Документации намного дружелюбнее:
Закончили? Создайте пулреквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки!
Может стоить использовать что-то такое
| @@ -10,23 +10,26 @@ | |||
|
|
|||
| Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой. | |||
There was a problem hiding this comment.
Дока — это добрая энциклопедия...
Можно добавить ссылку на сайт прям сразу тут:
Дока — это добрая энциклопедия...
| 📘 Этот репозиторий содержит только тексты статей и материалов проекта «[Дока](https://doka.guide/)»! | ||
| 📘 Этот репозиторий содержит тексты статей и материалов проекта «[Дока](https://doka.guide/)»! | ||
|
|
||
| [Остальные репозитории Доки](https://github.com/doka-guide) |
There was a problem hiding this comment.
Остальные репозитории Доки...
Может лучше что-то типа: Главная страница проекта на GiHub ?
По следам обсуждения в чате несу новую порцию правок в главный ридми этого репозитория.
Что не очень нравится и требует обсуждения:
Как-то криво получилось, имхо. Буду рада предложениям =)