DISCOVERY-293: Add local nav pointers #310

azinit · 2021-10-23T16:34:06Z

DISCLAIMER

Смело дели пополам дифф, т.к. это удвоение диффа из-за двух локалей

CHANGELOG

feat: Добавил навигационные карты для каждой секции
- (GetStarted, Guides, Concepts, Reference, About)
- Поправил пагинацию и порядок, чтобы nav-item рутовый был на самом верху
- С отображением бейджа-цели, описания и основных статей в каждой такой странице
- Для каждой такой статьи подобрал актуальную иконку для более очевидного UX и мб ассоциативности
feat: Добавил "index"-овые урлы для этих navpointers, и актуализировал редиректы
feat: Для всего этого реализовал доп. компонент Row

💻- Light, EN fs.navpointers.light.en.mp4	💻 - Dark, RU fs.navpointers.dark.ru.mp4
📱 - Light, RU	📱 - Dark, RU

Чеклист

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

azinit

self-reviewed

Фух... Вродь постарался много подсказок оставить для облегчения ревью)

azinit · 2021-10-23T16:52:41Z

website/docusaurus.config.js

+// FIXME: Привести в порядок формат урлов
 const SECTIONS = {
    INTRO: {
        shortPath: "/docs",
        fullPath: "/docs/intro",
    },
    GET_STARTED: {
        shortPath: "/docs/get-started",
-        fullPath: "/docs/get-started/overview",
+        fullPath: "/docs/get-started",
    },
    CONCEPTS: {
        shortPath: "/docs/concepts",
-        fullPath: "/docs/concepts/architecture",
+        fullPath: "/docs/concepts",
    },
    GUIDES: {
        shortPath: "/docs/guides",
-        fullPath: "/docs/guides/migration-from-v1",
+        fullPath: "/docs/guides",
    },
    REFERENCE: {
        shortPath: "/docs/reference",
-        fullPath: "/docs/reference/glossary",
+        fullPath: "/docs/reference",


Позже выпилить бы совсем, но out-of-scope пока

azinit · 2021-10-23T16:53:19Z

website/i18n/en/docusaurus-plugin-content-docs/current/about/index.mdx

+---
+sidebar_position: 0
+sidebar_class_name: sidebar-item--root
+hide_table_of_contents: true
+slug: /about
+pagination_prev: reference/knowledge-types
+---
+
+# 🍰 About
+
+<span class="badge badge--violet margin-bottom--md">COMMUNITY-ORIENTED</span>
+
+<p class="summary">
+General information about methodology, team, community and development history
+</p>
+
+## Main
+
+import Row from "@site/src/shared/ui/row/tmpl.mdx"
+import { StarOutlined } from "@ant-design/icons";
+
+<Row 
+    title="Mission" 
+    description="Goals and limitations of the methodology"
+    to="/docs/about/mission"
+    Icon={StarOutlined}
+/>


Здесь опишу на примере одной index-овой статьи, дальше можно ревьювить по аналогии

sidebar_position: 0

Отображается выше всех

sidebar_class_name: sidebar-item--root

Для доп стилей поинтера в сайдбаре (чтобы отличался от других визуально)

hide_table_of_contents: true

Иначе выглядит странно, т.к. TOC состоит из одного пункта ## Main

Да и визуально от обычных статей отличается - тоже хорошо

slug: /about

Было два пути:

либо так, с индексовым файлом внутри,

либо выносить в файл /about.mdx с кучей проблем

Выбрал меньшее зло, и кмк - вполне неплохой компромисс по итогу вышел

pagination_prev: reference/knowledge-types

Каждая такая индексовая страница линкуется с концом предыдущего раздела

# 🍰 About

Сделал вместе с эмодзи для визуального отличия в пагинации и сайдбаре

<span class="badge badge--violet margin-bottom--md">COMMUNITY-ORIENTED</span>

Попробовал ради интереса отобразить семантичные теги согласно diataxis - вышло неплохо кмк 🤔

<p class="summary">

Взял как у аналогов

## Main

Тож как у аналогов - отображаю ключевые статьи из раздела, чтобы не распылялось внимание читателя

title="Mission" description="Goals and limitations of the methodology" to="/docs/about/mission" Icon={StarOutlined}

С тайтлом карточки, саммари для понимания о чем статья и семантичной иконкой

azinit · 2021-10-23T17:06:08Z

website/i18n/en/docusaurus-plugin-content-docs/current/about/mission.md

@@ -1,6 +1,5 @@
 ---
 sidebar_position: 1
-pagination_prev: reference/knowledge-types


Ну а здесь и далее убрал старую индексацию основных страниц категорий, т.к. теперь ими стали наши навпоинтеры

azinit · 2021-10-23T17:06:45Z

website/i18n/ru/docusaurus-plugin-content-docs/current/about/index.mdx

+pagination_prev: reference/knowledge-types
+---
+
+# 🍰 О методологии


А теперь все тож самое но на русском 🤯🤯🤯

azinit · 2021-10-23T17:07:25Z

website/i18n/ru/docusaurus-plugin-content-docs/current/reference/knowledge-types.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 10
-pagination_next: about/mission
+pagination_next: about/index


Последняя дока из диффа фух!

azinit · 2021-10-23T17:08:03Z

website/src/app/index.css

+.sidebar-item--root {
+    margin-bottom: 6px;
+    font-weight: bold;
+    text-transform: uppercase;
+}
+
+.summary {
+    padding-bottom: 2rem;
+    font-size: 1.25rem;
+    color: var(--ifm-color-gray-600);
+    border-bottom: 1px solid var(--ifm-color-gray-400);
+}
+
+.badge--violet {
+    --ifm-badge-background-color: #5c21dd;
+    --ifm-badge-border-color: var(--ifm-badge-background-color);
+}


Стили для navpointers)

azinit · 2021-10-23T17:08:18Z

website/src/app/index.css

+}
+
+html[data-theme=dark] .badge--warning {
+    --ifm-badge-background-color: var(--ifm-color-warning-dark);


Ну а тут хак, т.к. в светлой теме желтый бейдж слишком ярко выглядит

azinit · 2021-10-23T17:08:34Z

website/src/shared/ui/row/index.jsx

+ * Row card for linking
+ * @see https://docusaurus.io/docs/next/markdown-features/react#importing-markdown
+ */
+export const Row = ({ title, description, to, Icon }) => {


Собсна, карточка статьи для отображения в навпоинтере

azinit · 2021-10-23T17:09:01Z

website/src/shared/ui/row/tmpl.mdx

@@ -0,0 +1,3 @@
+import Row from "./index.jsx";
+
+<Row {...props} />


Это особенный ~~костыль~~ вид синтаксиса для переиспользования в mdx

azinit · 2021-10-23T17:09:18Z

website/src/shared/ui/row/styles.module.css

@@ -0,0 +1,41 @@
+.root {


Полтоно стилей - если видите как упростить - welcome)

website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/index.mdx

website/i18n/ru/docusaurus-plugin-content-docs/current/guides/index.mdx

faisalman/ua-parser-js#536

azinit added 10 commits October 23, 2021 15:22

feat(navpointers): add local navpointers for sections

8e56d8e

fix(navpointers): remove redundant redirects

486588e

feat(navpointers): actualize descriptions

3c0ae26

feat(navpointers): add semantic tags

84d06a6

feat(navpointers): add UIKIT#row implementation

82c7adf

feat(navpointers): fullfill overview articles

35f0da2

feat(navpointers): add icons for overview articles

8a9524d

feat(navpointers): actualize pagination and positions

826dd84

feat(navpointers): actualize EN navpointers (map-content)

fc096a6

feat(navpointers): actualize EN navpointers (order and pagination)

f2e1735

azinit changed the base branch from master to feature/FEEDBACK-276-add-feedback-widget October 23, 2021 16:40

fix(navpointers): fix broken links

1c9ca72

azinit linked an issue Oct 23, 2021 that may be closed by this pull request

DISCOVERY: Add nav-pointers (locally) #293

Closed

5 tasks

azinit self-assigned this Oct 23, 2021

fix(navpointers): actualize navpointers intro title

7e4360a

azinit commented Oct 23, 2021

View reviewed changes

azinit requested review from Postamentovich, AlexandrHoroshih, GhostMayor, spotsccc and unordinarity October 23, 2021 17:10

Postamentovich reviewed Oct 23, 2021

View reviewed changes

website/i18n/ru/docusaurus-plugin-content-docs/current/concepts/index.mdx Show resolved Hide resolved

Postamentovich approved these changes Oct 23, 2021

View reviewed changes

website/i18n/ru/docusaurus-plugin-content-docs/current/guides/index.mdx Outdated Show resolved Hide resolved

review(navpointers): apply suggestion (editing)

bbbf1b2

AlexandrHoroshih approved these changes Oct 23, 2021

View reviewed changes

AlexandrHoroshih approved these changes Oct 24, 2021

View reviewed changes

chore(SECURITY): fixate ua-parser-js version

bd2d85b

faisalman/ua-parser-js#536

azinit merged commit df35628 into feature/FEEDBACK-276-add-feedback-widget Oct 24, 2021

azinit deleted the feature/DISCOVERY-293-nav-pointers-locally branch October 24, 2021 10:41

azinit restored the feature/DISCOVERY-293-nav-pointers-locally branch October 24, 2021 10:42

azinit deleted the feature/DISCOVERY-293-nav-pointers-locally branch October 24, 2021 10:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DISCOVERY-293: Add local nav pointers #310

DISCOVERY-293: Add local nav pointers #310

azinit commented Oct 23, 2021 •

edited

Loading

azinit left a comment

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

azinit Oct 23, 2021

		@@ -0,0 +1,3 @@
		import Row from "./index.jsx";

		<Row {...props} />

DISCOVERY-293: Add local nav pointers #310

DISCOVERY-293: Add local nav pointers #310

Conversation

azinit commented Oct 23, 2021 • edited Loading

DISCLAIMER

CHANGELOG

Чеклист

azinit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azinit commented Oct 23, 2021 •

edited

Loading