Conversation
furtivite
left a comment
furtivite
left a comment
There was a problem hiding this comment.
Очень классно, что у тебя дошли руки в этот документ. 🫶 Я внёс несколько комментариев и предложений, можем доделать.
README.md
Outdated
|
|
||
| > Подробная [**👉Документация👈**](docs/README.md) на случай, если хочется узнать больше про возможности Доки в плане контента. Например, посмотреть на дизайн-систему или создать свой профиль автора. | ||
| Остались вопросы? Приходите в [чат Доки](https://t.me/+qYFPI2mExuQxZTFi). | ||
| > ⚠️ Если сайт Доки медленно загружается или не работает совсем, попробуйте [фикс](docs/load-fix.md). |
There was a problem hiding this comment.
Мне нравится новый вариант текста, но лучше бы его оставить в самом начале документа. Там он решает задачу, с которой обращаются регулярно.
README.md
Outdated
| [](https://github.com/doka-guide/content/actions?query=workflow%3AProduct%20Deploy) | ||
|
|
||
| [⚠️ Если сайт Доки медленно загружается или не работает совсем](docs/load-fix.md) | ||
| [Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Мы делаем документацию по веб-разработке практичной, понятной и неунылой 🌚 |
There was a problem hiding this comment.
| [Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Мы делаем документацию по веб-разработке практичной, понятной и неунылой 🌚 | |
| [Дока](https://doka.guide/) — это добрая энциклопедия для веб-разработчиков. Мы делаем документацию по веб-разработке практичной, понятной и не унылой. |
Не уверен, что для всех доступен для понимания эмодзи. Добавил пропущенный пробел
There was a problem hiding this comment.
С эмодзи могу согласиться, дело вкуса. А вот с раздельным написанием прилагательного и частицы «не» в этом случае — нет) Почему решил добавить пробел?
There was a problem hiding this comment.
Да, тут, скорее я не прав. Давай просто без эмодзи?
There was a problem hiding this comment.
А слово унылый вообще подходит? Может заменить на нескучную?
Co-authored-by: Egor Levchenko <50330458+furtivite@users.noreply.github.com>
Co-authored-by: Egor Levchenko <50330458+furtivite@users.noreply.github.com>
|
Что-то мне захотелось чуть доработать текст, сечас вернусь) |
furtivite
left a comment
furtivite
left a comment
There was a problem hiding this comment.
Слушай, мне нравится, есть только один вопрос
| 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.
Да, тут тоже сначала не очень уверен был. Но решил добавить в конец, что типа разобраться во всем поможет документация и ссылка. А в ней можно раскрыть подробнее по этапам, как что сделать, когда какой шаблон выбрать итд.
Как тебе такой вариант?
There was a problem hiding this comment.
Мне ок, я думаю, разберутся. А потом попросим чатик посмотреть на инструкцию, которая получилась и проверить наши предположения)
Превью контента из 9a4f853 опубликовано. |
3 participants
Предлагаю поредачить внутреннюю документацию Доки, решил начать с README репозитория.
Какие вижу проблемы в текущей версии:
Предлагаю новую версию, в ней меньше визуального шума, нет дублей, короче текст и чище структура.