EDITING-422: Remove excessive text formatting, reorganize the text

feature-sliced / documentation

🍰 Architectural methodology for frontend projects

https://feature-sliced.design

MIT License

1.55k stars 165 forks source link

EDITING-422: Remove excessive text formatting, reorganize the text #428

Closed illright closed 2 years ago

illright commented 2 years ago

CHANGELOG

Removed the formatting from the intro section that wasn't improving readability.
Reorganized the benefits into a bullet list instead of two-line sections
Renamed the "Обзор" heading to "Преимущества"

Checklist

[x] I reviewed CONTRIBUTING guidelines
[x] I did a self-review of the changes
[x] I gave a brief description of the changes
[x] I awaited for CI checks
[x] I specified related materials if needed (discussion/issue/pull-request...)
[x] All requirements for the related issue are resolved if issue exists

Closes #422

Krakazybik commented 2 years ago

Если не сложно cкинь, пожалуйста, скрин =) Хоть посмотреть, чего на выходе получилось =)

illright commented 2 years ago

Если честно, сложно :) я попытался поднять доку, когда делал прошлый ПР, но делал через pnpm (у меня не установлен Yarn, не особо люблю его). Билд упал с ошибкой, рискну предположить, что где-то есть незадекларированная зависимость.

Надо, наверное, CI настроить, чтоб билдил доку с ПРов. Могу этим тоже когда-нибудь заняться. А ещё с удовольствием переведу проект на pnpm, но это можно позже обсудить.

Krakazybik commented 2 years ago

Ну определённо почище стало Но, субъективно, Javascript + React выбиваются из общего стиля. Может их JavaScript + React ?

Screenshot_20220127_124033

Screenshot_20220127_124105

illright commented 2 years ago

А что с английской версией страницы делать? Она, конечно, не входит в скоуп #422, но проблемы у нее идентичные, может быть, стоит захватить и ее?

azinit commented 2 years ago

А что с английской версией страницы делать? Она, конечно, не входит в скоуп #422, но проблемы у нее идентичные, может быть, стоит захватить и ее?

Думаю, следующими итерациями

Щас хотя бы что-то сносное на одном языке получить)

carina-akaia commented 2 years ago

Но, субъективно, Javascript + React выбиваются из общего стиля. Может их JavaScript + React ?

Думаю их вообще не нужно как-то выделять форматированием

azinit commented 2 years ago

@all-contributors please add @illright for doc, content

allcontributors[bot] commented 2 years ago

@azinit

I've put up a pull request to add @illright! :tada:

illright commented 2 years ago

Обратите, пожалуйста, внимание, я добавил в репо файл .vscode/settings.json. Не знаю, почему он был добавлен в игнор, такие файлы как раз и нужны для того, чтоб ставить принятые в проекте настройки, так что убрал из игнора. Скажите, ок ли это

illright commented 2 years ago

*sigh* посквошите, пожалуйста, когда будете мерджить

illright commented 2 years ago

@azinit посмотри еще раз, пожалуйста

azinit commented 2 years ago

Обратите, пожалуйста, внимание, я добавил в репо файл .vscode/settings.json. Не знаю, почему он был добавлен в игнор, такие файлы как раз и нужны для того, чтоб ставить принятые в проекте настройки, так что убрал из игнора. Скажите, ок ли это

По-моему до этого отреджектили подобный коммит от @RinAkaia по каким-то причинам

Давай пробнем оставить, но если будут проблемы - возможно выпилим 🤔

azinit commented 2 years ago

sigh посквошите, пожалуйста, когда будете мерджить

Да ладно, нечего стесняться)

carina-akaia commented 2 years ago

Так никаких проблем возникнуть и не может, это ж конфиги воркспэйса