chore(docs, demo): updated stories names, updated README (#532)

gravity-ui · Dec 20, 2024 · db1d1ca · db1d1ca
1 parent 3ebf14f
commit db1d1ca
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 21 deletions.
diff --git a/.storybook/preview.ts b/.storybook/preview.ts
@@ -12,7 +12,7 @@ const preview: Preview = {
         },
         options: {
             storySort: {
-                order: ['Playground', 'Docs', 'Extensions', ['Presets', '*'], '*'],
+                order: ['Playground', 'Docs', 'Extensions', 'Settings', ['Presets', '*'], '*'],
             },
         },
         controls: {

diff --git a/README-ru.md b/README-ru.md
@@ -51,6 +51,7 @@ function Editor({onSubmit}) {
   return <MarkdownEditorView stickyToolbar autofocus toaster={toaster} editor={editor} />;
 }
 ```
+
 Полезные ссылки:
 - [Как подключить редактор в Create React App](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-install-create-react-app--docs)
 - [Как добавить предварительный просмотр для режима разметки](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-preview--docs)
@@ -61,7 +62,13 @@ function Editor({onSubmit}) {
 - [Как добавить расширение GPT](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-connect-gpt--docs)
 - [Как добавить расширение привязки текста в Markdown](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-extension-with-popup--docs)
 
+### Разработка
+
+Для запуска Storybook в режиме разработки выполните следующую команду:
 
+```shell
+npm start
+```
 
 ### i18n
 
@@ -77,10 +84,7 @@ configure({
 
 Обязательно сделайте вызов `configure()` из [UIKit](https://github.com/gravity-ui/uikit?tab=readme-ov-file#i18n) и других UI-библиотек.
 
-## Разработка
 
-Для запуска Storybook в режиме разработки выполните следующую команду:
+### Участие в разработке
 
-```shell
-npm start
-```
+- [Информация для контрибьюетров](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-contributing--docs)
diff --git a/README.md b/README.md
@@ -61,6 +61,12 @@ Read more:
 - [How to add GPT extension](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-connect-gpt--docs)
 - [How to add text binding extension in markdown](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-develop-extension-with-popup--docs)
 
+### Development
+To start the dev storybook
+
+```shell
+npm start
+```
 
 
 ### i18n
@@ -77,10 +83,6 @@ configure({
 
 Don't forget to call `configure()` from [UIKit](https://github.com/gravity-ui/uikit?tab=readme-ov-file#i18n) and other UI libraries.
 
-## Development
+### Contributing
 
-To start the dev storybook
-
-```shell
-npm start
-```
+- [Contributor Guidelines](https://preview.gravity-ui.com/md-editor/?path=/docs/docs-contributing--docs)
diff --git a/demo/stories/css-variables/CSSVariables.stories.tsx b/demo/stories/css-variables/CSSVariables.stories.tsx
@@ -33,6 +33,6 @@ export const Story: StoryObj<typeof component> = {
 Story.storyName = 'Custom CSS Variables';
 
 export default {
-    title: 'Experiments / Custom CSS Variables',
+    title: 'Settings / Custom CSS Variables',
     component,
 };
diff --git a/docs/how-to-add-editor-with-create-react-app.md b/docs/how-to-add-editor-with-create-react-app.md
@@ -1,4 +1,4 @@
-##### Install / Create react app
+##### Getting started / Create react app
 
 ## Installation Guide
 

diff --git a/docs/how-to-add-editor-with-nextjs.md b/docs/how-to-add-editor-with-nextjs.md
@@ -1,4 +1,4 @@
-##### Install / NextJS
+##### Getting started / NextJS
 
 ## Connection and Configuration
 This document provides instructions for configuring Webpack and Turbopack to avoid issues related to the 'fs' module and for connecting the editor on the nextjs client side.

diff --git a/docs/how-to-add-preview.md b/docs/how-to-add-preview.md
@@ -1,4 +1,4 @@
-##### Develop / Preview
+##### Getting started / Preview
 
 ## How to Add Preview for Markup Mode
 

diff --git a/docs/how-to-connect-gpt-extensions.md b/docs/how-to-connect-gpt-extensions.md
@@ -1,4 +1,4 @@
-##### Connect / GPT
+##### Extensions / GPT
 
 ## How to connect GPT extensions to editor
 

diff --git a/docs/how-to-connect-html-extension.md b/docs/how-to-connect-html-extension.md
@@ -1,4 +1,4 @@
-##### Connect / Html block
+##### Extensions / Html block
 
 ## How to Connect the HTML Extension in the Editor
 

diff --git a/docs/how-to-connect-latex-extension.md b/docs/how-to-connect-latex-extension.md
@@ -1,4 +1,4 @@
-##### Connect / Latex extension
+##### Extensions / Latex extension
 
 ## How to Connect the Latex Extension in the Editor
 

diff --git a/docs/how-to-connect-mermaid-extension.md b/docs/how-to-connect-mermaid-extension.md
@@ -1,4 +1,4 @@
-##### Connect / Mermaid Extension
+##### Extensions / Mermaid Extension
 
 ## How to Connect the Mermaid Extension in the Editor
 

diff --git a/docs/how-to-customize-the-editor.md b/docs/how-to-customize-the-editor.md
@@ -1,4 +1,4 @@
-##### Develop / Editor customization
+##### Getting started / Editor customization
 
 ## How to customize the editor
 You can use CSS variables to make editor contents fit your own needs