diff --git a/README.md b/README.md index 3fc5e3568b..ec1c00b5e2 100644 --- a/README.md +++ b/README.md @@ -4,32 +4,26 @@ [![Статус проверки ссылок](https://github.com/doka-guide/content/actions/workflows/link-checker-all.yml/badge.svg)](https://github.com/doka-guide/content/actions/workflows/link-checker-all.yml) [![Статус деплоя](https://github.com/doka-guide/content/workflows/Product%20Deploy/badge.svg)](https://github.com/doka-guide/content/actions?query=workflow%3AProduct%20Deploy) -[⚠️ Если сайт Доки медленно загружается или не работает совсем](docs/load-fix.md) +[Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Мы делаем документацию по веб-разработке практичной, понятной и неунылой 🌚 -[Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой. +> 📃 Этот репозиторий содержит контент Доки: тексты, картинки, советы и тому подобное. Если вам интересно поучаствовать в развитии платформы, загляните в [её репозиторий](https://github.com/doka-guide/platform/). -📘 Этот репозиторий содержит контент проекта «[Дока](https://doka.guide/)»! +Присоединяйтесь к [нашему каналу в Телеграм](https://t.me/doka_guide), чтобы быть в курсе последних новостей проекта, и приходите в [чат Доки](https://t.me/+qYFPI2mExuQxZTFi), чтобы пообщаться, задать вопрос или просто хорошо провести время. -[Главная страница проекта на Гитхабе](https://github.com/doka-guide) +## Как сделать вклад? -Присоединяйтесь к [нашему сообществу в Телеграм](https://t.me/doka_guide), чтобы быть в курсе последних новостей, или к [чату](https://t.me/+qYFPI2mExuQxZTFi), чтобы пообщаться, задать вопрос и просто хорошо провести время. +Все тексты хранятся в формате Markdown, примеры кода — в HTML. Вам не нужно учить сложные инструменты, начать работать легко: -## Как начать? - -Все тексты хранятся в формате Маркдаун, демо — в HTML. Это облегчает работу с ними и не требует дополнительных инструментов. - -1. Сделайте форк этого репозитория. ([Как сделать форк?](https://doka.guide/recipes/github-new-fork/)) -1. Склонируйте форк репозитория на компьютер. ([Как клонировать репозиторий?](https://doka.guide/recipes/github-clone-repo/)) +1. [Сделайте форк](https://doka.guide/recipes/github-new-fork/) этого репозитория. +1. [Склонируйте форк](https://doka.guide/recipes/github-clone-repo/) репозитория на компьютер. 1. Создайте новую ветку. 1. Работайте над материалом и делайте коммиты в процессе работы. -1. Закончили? Создайте пулреквест. ([Как создать пулреквест?](https://doka.guide/recipes/github-new-pull-request/)) - -Вот и всё! После небольшой проверки ваш материал появится на сайте Доки! +1. Закончили? [Создайте пулреквест](https://doka.guide/recipes/github-new-pull-request/). +Вот и всё! Ваш материал проверит добрая редакция и вскоре он появится на сайте Доки! А чтобы ревью прошло быстро, изучите [наши правила](docs/README.md), там есть много важного: готовые шаблоны, руководства по стилю и другие инструкции. -> Подробная [**👉Документация👈**](docs/README.md) на случай, если хочется узнать больше про возможности Доки в плане контента. Например, посмотреть на дизайн-систему или создать свой профиль автора. -Остались вопросы? Приходите в [чат Доки](https://t.me/+qYFPI2mExuQxZTFi). +> ⚠️ Если сайт Доки медленно загружается или не работает совсем, попробуйте [фикс](docs/load-fix.md). --- -Распространяется под лицензиями [CC BY-NC-SA 4.0](LICENSE-SA.md) и [CC BY-NC-ND 4.0](LICENSE-ND.md), подробнее читайте [в документации](docs/license.md). +Распространяется под лицензиями [CC BY-NC-SA 4.0](LICENSE-SA.md) и [CC BY-NC-ND 4.0](LICENSE-ND.md), подробнее читайте в разделе о [лицензиях](docs/license.md).