Skip to content
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
> ⚠️ Если сайт Доки медленно загружается или не работает совсем, [попробуйте фикс](docs/load-fix.md).

[Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.
Дока — это добрая энциклопедия для веб-разработчиков. Мы делаем документацию по веб-разработке практичной, понятной и неунылой.

📘 Этот репозиторий содержит контент проекта «[Дока](https://doka.guide/)»!
Этот репозиторий содержит контент Доки: тексты, картинки, советы и тому подобное. Если вам интересно сделать вклад в развитие платформы, то загляните [в её код](https://github.com/doka-guide/platform/), он тоже открыт для участия.

[Главная страница проекта на Гитхабе](https://github.com/doka-guide)
Присоединяйтесь [к нашему каналу в Телеграм](https://t.me/doka_guide), чтобы быть в курсе последних новостей проекта, и приходите [в чат Доки](https://t.me/+qYFPI2mExuQxZTFi), чтобы пообщаться, задать вопрос или развлечься.

Присоединяйтесь к [нашему сообществу в Телеграм](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. Форкните этот репозиторий.
1. Клонируйте форк на компьютер.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Точно уверен, что стоит удалить ссылки на "Как сделать?" Давай попробуем сохранить, уверен, что есть желающие сделать контрибьюшн, у которых может быть много полезных знаний по теме, но мало по гиту.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Как тебе такой вариант?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Мне ок, я думаю, разберутся. А потом попросим чатик посмотреть на инструкцию, которая получилась и проверить наши предположения)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Отличная идея!

1. Создайте новую ветку.
1. Работайте над материалом и делайте коммиты в процессе работы.
1. Закончили? Создайте пулреквест. ([Как создать пулреквест?](https://doka.guide/recipes/github-new-pull-request/))

Вот и всё! После небольшой проверки ваш материал появится на сайте Доки!

1. Закончили? Создайте пулреквест.

> Подробная [**👉Документация👈**](docs/README.md) на случай, если хочется узнать больше про возможности Доки в плане контента. Например, посмотреть на дизайн-систему или создать свой профиль автора.
Остались вопросы? Приходите в [чат Доки](https://t.me/+qYFPI2mExuQxZTFi).
Вот и всё! Ваш материал проверит добрая редакция, и он появится на сайте Доки. А чтобы лучше во всем разобраться и даже ускорить ревью, изучите [нашу документацию](docs/README.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).
Loading