docs(editorial policy) by alyonurchick1 · Pull Request #52 · consta-design-system/consta-design-system.github.io

alyonurchick1 · 2024-11-05T13:35:58Z

Добавленные разделы:

Разделы будут обновляться по мере добавления новых разделов в связи с:

Обеспечением корректного перехода по ссылкам между разделами
Внедрением нового компонента Informer в доку
Обеспечением консистентности
Вычиткой и редактированием

!Не заливать на портал до момента добавления всех разделов. Я отпишусь, когда добавлю всё

Closes #3760

alyonurchick1 · 2024-11-05T13:37:17Z

@gizeasy хочу заменить пример компонента на какой-нибудь более простой и короткий. посмотри, пожалуйста, как выйдешь с больничного

github-actions · 2024-11-05T13:40:37Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2024-11-06T11:02:00Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2024-11-06T11:07:46Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2024-11-07T08:42:58Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

alyonurchick1 · 2024-11-07T14:35:27Z

@linturaven , посмотри, пожалуйста, страницу "Структура документации". Получится ли переделать эту схему и другие картинки так, чтобы было красиво и не громоздко.

github-actions · 2024-11-07T17:32:49Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

edit documentation structure and add setting up documentation

github-actions · 2024-11-13T11:04:31Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

gizeasy · 2024-11-13T12:10:05Z

+
+## Настройки раздела
+
+В файле с раширением `.tsx` вы можете задать настройки раздела:


раширением -> расширением

gizeasy · 2024-11-13T12:16:58Z

+Документация состоит из двух типов файлов:
+
+- [страница раздела](#страницы-раздела) – файл с расширением `.mdx`.
+- [настройки раздела](#настройки-раздела) – файл с расширением `.tsx`.


Давай будем писать про расширение .ts. .tsx - используется в как обозначение jsx синтаксиса а в настройках его обычно нет. Просто сборка по может кушать и .ts, и.tsx. Но правельнее использовать .ts

gizeasy · 2024-11-13T12:18:18Z

+
+Где:
+
+- `title` – название страницы. Оно будет отображаться вверху страницы в качестве заголовка H1.


Заголовок страницы

gizeasy · 2024-11-13T12:19:34Z

+- `group` – группа (раздел), к которой принадлежит страница. Все группы разделов можно посмотреть в папке `stand` в файле `standConfig.ts`.
+- `order` – порядок отображения страницы на портале. Так, чтобы отобразить страницу в первом разделе второй, задайте значение `120`.
+- `alias` – ключевые слова для поиска по порталу.
+- `description` – краткое описание содержимого страницы. Отображается на портале внизу названия страницы.


Отображается на портале внизу названия страницы.
->
Отображается под заголовком страницы.

gizeasy · 2024-11-13T12:19:56Z

+
+Где:
+
+- `title` – название страницы. Оно будет отображаться вверху страницы в качестве заголовка H1.


Заголовок

gizeasy · 2024-11-13T12:25:46Z

+<>
+
+```jsx
+import { createStand } from '##/stand/standConfig';


Кажется что не нужно спутывать понятия раздел, страница, группа.

createStand - создает страницу, страница может быть о компоненте а может в общем рассказывать о принципах(и т.п.)

Страница существует в группе, группа в библиотеке.

gizeasy · 2024-11-13T12:26:35Z

+</>
+</MdxTabs>
+
+## Страницы раздела


Вкладки страницы

gizeasy · 2024-11-13T12:47:57Z

gizeasy · 2024-11-13T12:48:15Z

gizeasy · 2024-11-13T12:55:58Z

+- [страница раздела](#страницы-раздела) – файл с расширением `.mdx`.
+- [настройки раздела](#настройки-раздела) – файл с расширением `.tsx`.
+
+## Настройки раздела


ввести понятие стенда
раздел это стенд

.stand.mdx - главная страница стенда
dev.stand.mdx и прочие tab.stand.mdx - второстипеные страницы

github-actions · 2024-11-18T14:11:50Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2024-11-18T14:38:34Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2024-11-20T10:06:15Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

alyonurchick1 · 2025-01-20T09:55:21Z

мб не "предупреждение", а "важно"

alyonurchick1 · 2025-01-20T09:59:23Z

https://refs-pull-52-merge---portal.consta.design/libs/portal/portal-formatting-rules?hash=%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%87%D0%B0%D0%BD%D0%B8%D0%B5 -сломалась верстка в примечаниях

alyonurchick1 · 2025-01-20T10:04:11Z

убрать блок "Заметки"

github-actions · 2025-01-22T10:19:44Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-01-29T09:53:43Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-01-29T15:09:24Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-03-19T09:44:55Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

…ign-system/portal into docs/editorial-policy

github-actions · 2025-03-19T11:46:58Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-03-19T12:03:15Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-05-21T09:46:00Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

github-actions · 2025-05-27T13:44:58Z

🎉 Deployed at http://refs-pull-52-merge---portal.consta.design

docs(editorial policy): add formatting rules

a8762af

Closes #3760

alyonurchick1 requested a review from gizeasy November 5, 2024 13:35

alyonurchick1 requested review from BagenovA and N1MBER as code owners November 5, 2024 13:35

alyonurchick1 self-assigned this Nov 5, 2024

alyonurchick1 removed request for BagenovA and N1MBER November 5, 2024 13:36

docs(editorial policy): add types of section

621fa91

Update typesOfSections.stand.mdx

8756ac8

Update typesOfSections.stand.mdx

7244b23

docs(editorial policy): add documentation structure

cf9f66f

alyonurchick1 added 2 commits November 13, 2024 13:58

docs(editorial policy): add setting up documentation

36602b9

edit documentation structure and add setting up documentation

Update settingUpDocumentation.stand.mdx

8b28bb1

alyonurchick1 changed the title ~~docs(editorial policy): add formatting rules~~ docs(editorial policy) Nov 13, 2024

gizeasy requested changes Nov 13, 2024

View reviewed changes

Создала отдельную папку для раздела Portal

d79dbe4

Update settingUpDocumentation.stand.mdx

2cb1f73

Работа с гитом

6c75177

Update documentationStructure.stand.mdx

ef63586

update

021b3e7

Merge branch 'master' into docs/editorial-policy

7c088b6

update

b84cd83

alyonurchick1 added 2 commits January 29, 2025 18:03

union pages

e668015

union

695bc0a

gizeasy and others added 5 commits February 24, 2025 13:01

Update package.json

46ece0d

Update package.json

903abc6

Merge branch 'master' into docs/editorial-policy

e52ac67

add props naming rules

4ed2396

Update deploy.yml

75c0719

alyonurchick1 added 2 commits March 19, 2025 14:39

Update namingRules.stand.mdx

4b9005e

Merge branch 'docs/editorial-policy' of https://github.com/consta-des…

d5c130e

…ign-system/portal into docs/editorial-policy

Update namingRules.stand.mdx

02dfbb9

gizeasy force-pushed the master branch 4 times, most recently from 2169f1f to 03848c2 Compare April 29, 2025 12:52

Merge branch 'master' into docs/editorial-policy

fe6c2ef

gizeasy merged commit a290b92 into master May 27, 2025
5 checks passed


		## Настройки раздела

		В файле с раширением `.tsx` вы можете задать настройки раздела:


		Где:

		- `title` – название страницы. Оно будет отображаться вверху страницы в качестве заголовка H1.

Conversation

alyonurchick1 commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alyonurchick1 commented Nov 5, 2024

Uh oh!

github-actions Bot commented Nov 5, 2024

Uh oh!

github-actions Bot commented Nov 6, 2024

Uh oh!

github-actions Bot commented Nov 6, 2024

Uh oh!

github-actions Bot commented Nov 7, 2024

Uh oh!

alyonurchick1 commented Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 7, 2024

Uh oh!

github-actions Bot commented Nov 13, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 18, 2024

Uh oh!

github-actions Bot commented Nov 18, 2024

Uh oh!

github-actions Bot commented Nov 20, 2024

Uh oh!

alyonurchick1 commented Jan 20, 2025

Uh oh!

alyonurchick1 commented Jan 20, 2025

Uh oh!

alyonurchick1 commented Jan 20, 2025

Uh oh!

github-actions Bot commented Jan 22, 2025

Uh oh!

github-actions Bot commented Jan 29, 2025

Uh oh!

github-actions Bot commented Jan 29, 2025

Uh oh!

github-actions Bot commented Mar 19, 2025

Uh oh!

github-actions Bot commented Mar 19, 2025

Uh oh!

github-actions Bot commented Mar 19, 2025

Uh oh!

github-actions Bot commented May 21, 2025

Uh oh!

github-actions Bot commented May 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alyonurchick1 commented Nov 5, 2024 •

edited

Loading

alyonurchick1 commented Nov 7, 2024 •

edited

Loading