Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Доработка главного ридми. 2 итерация #5458

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,26 @@

Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.
solarrust marked this conversation as resolved.
Show resolved Hide resolved
solarrust marked this conversation as resolved.
Show resolved Hide resolved

📘 Этот репозиторий содержит только тексты статей и материалов проекта «[Дока](https://doka.guide/)»!
📘 Этот репозиторий содержит тексты статей и материалов проекта «[Дока](https://doka.guide/)»!

[Остальные репозитории Доки](https://github.com/doka-guide)
Copy link
Contributor

Choose a reason for hiding this comment

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

Остальные репозитории Доки...

Может лучше что-то типа: Главная страница проекта на GiHub ?


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

## Как начать?

Все тексты хранятся в формате Маркдаун, демо — в HTML. Это облегчает работу с ними и не требует дополнительных инструментов.

1. Сделайте форк этого репозитория.
1. Склонируйте форк репозитория на компьютер.
1. Откройте папку репозитория в редакторе.
1. Создайте новую ветку.
1. Сделайте форк этого репозитория. ([Как сделать форк?](https://doka.guide/recipes/github-new-fork/))
1. Склонируйте форк репозитория на компьютер. ([Как клонировать репозиторий?](https://doka.guide/recipes/github-clone-repo/))
1. Создайте новую ветку.
1. Работайте над материалом.
1. В процессе работы делайте коммиты.
1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки.
1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. ([Как создать пулреквест?](https://doka.guide/recipes/github-new-pull-request/))
solarrust marked this conversation as resolved.
Show resolved Hide resolved
solarrust marked this conversation as resolved.
Show resolved Hide resolved

Если в процессе возникли вопросы, то их можно задать в [чате Доки](https://t.me/+qYFPI2mExuQxZTFi).
solarrust marked this conversation as resolved.
Show resolved Hide resolved
solarrust marked this conversation as resolved.
Show resolved Hide resolved

[Документация](docs/README.md)
> Подробная [**👉Документация👈**](docs/README.md) на случай, если хочется узнать больше про возможности Доки в плане контента. Например, посмотреть на дизайн-систему или создать свой профиль автора.
Copy link
Contributor

Choose a reason for hiding this comment

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

Подробная 👉Документация👈 на случай, если ...

Мне кажется не стоит указывать причину по которой Документация может понадобиться )
Что если, кратким списком ссылок перечислить какие вопросы в документации подробно рассмотрены (разделы доки, стиль и тд.) ?


solarrust marked this conversation as resolved.
Show resolved Hide resolved
---

Expand Down
Loading