Skip to content

DISCOVERY-332: Restructure of docs - 🔎 Intro#339

Merged
azinit merged 18 commits intomasterfrom
feature/DISCOVERY-332-restruct--intro
Nov 6, 2021
Merged

DISCOVERY-332: Restructure of docs - 🔎 Intro#339
azinit merged 18 commits intomasterfrom
feature/DISCOVERY-332-restruct--intro

Conversation

@azinit
Copy link
Copy Markdown
Member

@azinit azinit commented Nov 4, 2021

DISCLAIMER

  • Не поверите, но дифф большой в виду перевода для обоих локалей (+ git не смог в "ренейминг" файлов)

image

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

CHANGELOG

  • feat: Реструктурировал Intro раздел-страницу
    • Перенес Overview из get-started
    • Скопировал Motivation из README
  • chore: Проработал совместимость
    • Обновил редиректы
    • Поправил референсные ссылки под новый формат
    • Добавил NavPage вспомогательную страницу для поиска "старых" роутов (чисто для совместимости)
  • fix: Поправил заодно багулю по адаптивности виджета фидбека

Чеклист

fs.restruct.-.intro.mp4

Intro Dark (🇬🇧)

Скрин со старым тайтлом, но прошу понять
image

Intro Light (🇬🇧)
image

HelpNav (🇬🇧)
image

Intro (🇷🇺)
image

Intro (🇷🇺)
image

HelpNav (🇷🇺)
image

  • Если при работе с документацией потребовалось использовать github-дискуссии, то стоит их прикрепить как see-also источники
  • Если PR связан с задачей, то необходимо проверить, что все требования по задаче выполнены
  • Перед тем, как отправлять изменения на ревью, нужно ознакомиться с CONTIBUTING-гайдлайнами
  • Перед тем, как отправлять изменения на ревью, нужно провести self-review своих изменений
  • Перед тем, как отправлять изменения на ревью, нужно дождаться CI-проверок
  • Перед тем, как отправлять изменения на ревью, нужно дать краткое описание изменений

Copy link
Copy Markdown
Member Author

@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.

self-reviewed

Comment thread website/docusaurus.config.js
Comment thread website/docusaurus.config.js
Comment thread website/docusaurus.config.js
@@ -1,67 +0,0 @@
---
sidebar_position: 1
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

По сути перенес из get-started, т.к. там этой статье незачем быть (Overview как никак)

Comment thread website/src/pages/_home/index.jsx
}

/* FIXME: hardcoded */
html[data-theme='dark'] .schemeImg {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

"унифицируем логику" [2]

import { Row } from "@site/src/shared/ui/row";
import styles from "./styles.module.css";

const NavPage = () => {
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Собсна, страница навигации со старыми роутами

(Скорее всего что-нибудь еще со временем сюда добавим для облегчения)

Comment thread website/src/shared/ui/row/index.jsx
Comment thread website/i18n/en/docusaurus-plugin-content-docs/current/intro.mdx
@azinit
Copy link
Copy Markdown
Member Author

azinit commented Nov 4, 2021

Ну и кста да, пожалуй так много изменений и проработки этой страницы - потому что это второе лицо документации сразу после лендинга)

Copy link
Copy Markdown
Contributor

@AlexandrHoroshih AlexandrHoroshih 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 linked an issue Nov 4, 2021 that may be closed by this pull request
11 tasks
@azinit
Copy link
Copy Markdown
Member Author

azinit commented Nov 6, 2021

@feature-sliced/core @feature-sliced/contributors Гляньте пож 👀

Comment thread website/src/shared/ui/row/styles.module.css Outdated
Comment thread website/src/shared/ui/row/index.jsx
spotsccc
spotsccc previously approved these changes Nov 6, 2021
@azinit azinit dismissed stale reviews from spotsccc and AlexandrHoroshih via d4fc1f4 November 6, 2021 17:56
@azinit azinit merged commit f41ff16 into master Nov 6, 2021
@azinit azinit deleted the feature/DISCOVERY-332-restruct--intro branch November 6, 2021 17:59
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.

DISCOVERY: (Restruct) 🔎 Intro section

4 participants