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

EDITING-423: Purge redundant links and reorder the content #432

Merged
merged 7 commits into from
Feb 13, 2022
Merged

EDITING-423: Purge redundant links and reorder the content #432

merged 7 commits into from
Feb 13, 2022

Conversation

illright
Copy link
Member

@illright illright commented Feb 1, 2022

CHANGELOG

Много чего тут поменялось:

  1. Убрал ссылки из первого параграфа.
    Причина в двух словах: эти ссылки вели в никуда. Для ссылки важно не только то, куда она ведет, но еще и откуда, чтоб при переходе по ней было понятно, какой информационный гэп заполняет эта ссылка.
  2. Уточнил, куда ведет ссылка под диаграммой
  3. Объединил разделы "Обзор" и "Преимущества"
    Ранее в разделе "Преимущества" была фраза "Для этого она вводит ряд концепций и абстракций, на которых может базироваться архитектура от проекта к проекту. Отсюда получаем ряд преимуществ", в которой не было понятно, какие концепты и абстракции, так что слово "отсюда" было не очень соединенным.
  4. Убрал большую часть карточек
    Они просто дублировали навигационный хедер, и не давали никаких советов о том, кому стоит переходить именно по этой карточке. Я считаю, что главным образом нужны только две карточки – на логическое продолжение страницы и на примеры.

Еще одна проблема: Docusaurus сам предоставляет переход на следующую страницу, поэтому эти карточки немного дублируют этот функционал, что не очень хорошо. Плюс там между ними есть виджет лайков-дизлайков документации, в ценности которого я тоже немного сомневаюсь.

Скриншот, где видно дублирование функционала дублирование функционала
Полностраничный скриншот результата

полностраничный скриншот результата

Closes #423

Checklist

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

@azinit
Copy link
Member

azinit commented Feb 1, 2022

Лучше в след раз темплейт не убирай пож)

Copy link
Member

@azinit azinit left a comment

Choose a reason for hiding this comment

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

Остальное позже гляну
Видно, что стало ссылок поменьше, и в целом Intro стал почище

Но по NavCards прям подискутировать надо))

@illright
Copy link
Member Author

illright commented Feb 1, 2022

Лучше в след раз темплейт не убирай пож)

Почему?

@azinit
Copy link
Member

azinit commented Feb 1, 2022

Лучше в след раз темплейт не убирай пож)

Почему?

В темплейте подробно описано почему :)

image

Copy link
Member

@azinit azinit left a comment

Choose a reason for hiding this comment

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

Ознакомился внимательней
В целом оч даже гуд, но есть что улучшить))
(пока прям "блокер" - это удаленные карточки в конце)

@azinit
Copy link
Member

azinit commented Feb 2, 2022

@RinAkaia @unordinarity @AlexandrHoroshih вы там где?)

@illright
Copy link
Member Author

illright commented Feb 3, 2022

@azinit порезолви, пожалуйста, треды, в которых достигнут консенсус, а то голова уже идет кругом)

@azinit
Copy link
Member

azinit commented Feb 3, 2022

@azinit порезолви, пожалуйста, треды, в которых достигнут консенсус, а то голова уже идет кругом)

Порезолвил))

@azinit
Copy link
Member

azinit commented Feb 9, 2022

@illright Мб добьем и вольем? Вроде по этому PR чуть чуть осталось 🤔
(в рамках задачи и замечаний)

@illright
Copy link
Member Author

illright commented Feb 9, 2022

Прямо сейчас мне немного не до этого, горит парочка других вещей. В ближайшие дни вернусь

Благодаря этому сохраняется баланс между соблюдением принципа **DRY** и возможностью адаптировать модуль под разные цели.

- **Устойчивость к изменениям и рефакторингу**
Каждый компонент архитектуры имеет свое назначение и предсказуемый список зависимостей.
Благодаря этому приложение можно модифицировать под новые требования без непредвиденных последствий.
Один модуль не может использовать другой модуль, расположенный на том же слое или на слоях выше.
Copy link
Member

Choose a reason for hiding this comment

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

Вынужденная мера, исключительно чтобы поскорей закрыть PR
(лучше до такого не доводить)

Если есть несогласие, то предлагаю на некст итерациях обсудить 🤔

А зачем? (не для холиваров)
  1. Я/МЫ Слайс
    Я почти уговорил себя, чтобы поскорее закрыть PR - но так резало это "слайс" в месте, где у человека должен быть ответ на вопрос "А в чем ваше преимущество? Как ваш способ связывать модулей может улучшить ситуацию?"

    И тут мы такие "чувак, мы тут слайсеры, у нас нет слова "модуль", онли "слайс"

    Это очень отбивает кмк

    image

  2. Too Confused
    Также заметил, что при "рефакторинге и мердже" сильно сбился изначальный смысл абзацев, так что свапнул предложения "ближе к канону"
    (можем в дальнейшем, опять же, обсудить твои предложения)

    image

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

@azinit azinit left a comment

Choose a reason for hiding this comment

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

Ура, наконец вливаем))

Надеюсь мы друг друга правильно поняли в контексте "радикальности и своевременности изменений"

Сам видишь к чему приводит 😏

@azinit azinit merged commit a4c9f3e into feature-sliced:master Feb 13, 2022
@azinit
Copy link
Member

azinit commented Feb 13, 2022

@illright Спасибо отдельно, что вносил правки, даже когда не до конца был согласен!

@azinit
Copy link
Member

azinit commented Feb 13, 2022

@all-contributors please add @illright for ideas

@allcontributors
Copy link
Contributor

@azinit

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

@illright illright deleted the fix/intro-too-many-links branch February 13, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EDITING(INTRO): Clean up from redundant links
3 participants