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