From d18e6b8da5734b61569d72bfaafc3481df4024ec Mon Sep 17 00:00:00 2001 From: Igor Zvyagin Date: Mon, 4 Mar 2024 10:25:51 +0300 Subject: [PATCH] improve desc for app --- src/{ => app}/App.css | 0 src/{ => app}/App.tsx | 0 src/{ => app}/index.css | 0 src/{ => app}/logo.svg | 0 src/app/readme.md | 3 +++ src/entities/readme.md | 4 +++- src/features/readme.md | 4 +++- src/index.html | 2 +- src/index.tsx | 4 ++-- src/pages/readme.md | 4 +++- src/shared/readme.md | 4 +++- src/widgets/readme.md | 4 +++- 12 files changed, 21 insertions(+), 8 deletions(-) rename src/{ => app}/App.css (100%) rename src/{ => app}/App.tsx (100%) rename src/{ => app}/index.css (100%) rename src/{ => app}/logo.svg (100%) create mode 100644 src/app/readme.md diff --git a/src/App.css b/src/app/App.css similarity index 100% rename from src/App.css rename to src/app/App.css diff --git a/src/App.tsx b/src/app/App.tsx similarity index 100% rename from src/App.tsx rename to src/app/App.tsx diff --git a/src/index.css b/src/app/index.css similarity index 100% rename from src/index.css rename to src/app/index.css diff --git a/src/logo.svg b/src/app/logo.svg similarity index 100% rename from src/logo.svg rename to src/app/logo.svg diff --git a/src/app/readme.md b/src/app/readme.md new file mode 100644 index 000000000..ead6dea40 --- /dev/null +++ b/src/app/readme.md @@ -0,0 +1,3 @@ +`app` — настройки, стили и провайдеры для всего приложения. + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview) diff --git a/src/entities/readme.md b/src/entities/readme.md index 6ceaf3e6b..b1f6440ca 100644 --- a/src/entities/readme.md +++ b/src/entities/readme.md @@ -1 +1,3 @@ -`entities` (сущности) — бизнес-сущности. (например, User, Product, Order) \ No newline at end of file +`entities` (сущности) — бизнес-сущности. (например, User, Product, Order) + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview) diff --git a/src/features/readme.md b/src/features/readme.md index c614268d8..2b86102c2 100644 --- a/src/features/readme.md +++ b/src/features/readme.md @@ -1 +1,3 @@ -`features` (фичи) — взаимодействия с пользователем, действия, которые несут бизнес-ценность для пользователя. (например, SendComment, AddToCart, UsersSearch) \ No newline at end of file +`features` (фичи) — взаимодействия с пользователем, действия, которые несут бизнес-ценность для пользователя. (например, SendComment, AddToCart, UsersSearch) + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview) diff --git a/src/index.html b/src/index.html index 6d64cb21e..c8a8e9634 100644 --- a/src/index.html +++ b/src/index.html @@ -2,7 +2,7 @@ My project - + diff --git a/src/index.tsx b/src/index.tsx index 652531e4b..26d2b1437 100644 --- a/src/index.tsx +++ b/src/index.tsx @@ -1,7 +1,7 @@ import React from 'react'; import ReactDOM from 'react-dom/client'; -import './index.css'; -import App from './App'; +import './app/index.css'; +import App from './app/App'; const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement); root.render( diff --git a/src/pages/readme.md b/src/pages/readme.md index 7d3fa71a2..9b804b51c 100644 --- a/src/pages/readme.md +++ b/src/pages/readme.md @@ -1 +1,3 @@ -`pages` (страницы) — композиционный слой для сборки полноценных страниц из сущностей, фич и виджетов. \ No newline at end of file +`pages` (страницы) — композиционный слой для сборки полноценных страниц из сущностей, фич и виджетов. + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview) \ No newline at end of file diff --git a/src/shared/readme.md b/src/shared/readme.md index c614268d8..66a97b417 100644 --- a/src/shared/readme.md +++ b/src/shared/readme.md @@ -1 +1,3 @@ -`features` (фичи) — взаимодействия с пользователем, действия, которые несут бизнес-ценность для пользователя. (например, SendComment, AddToCart, UsersSearch) \ No newline at end of file +`shared` — переиспользуемый код, не имеющий отношения к специфике приложения/бизнеса. (например, UIKit, libs, API) + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview) diff --git a/src/widgets/readme.md b/src/widgets/readme.md index 9ac21d8bb..dfab50893 100644 --- a/src/widgets/readme.md +++ b/src/widgets/readme.md @@ -1 +1,3 @@ -`widgets` (виджеты) — композиционный слой для соединения сущностей и фич в самостоятельные блоки (например, IssuesList, UserProfile). \ No newline at end of file +`widgets` (виджеты) — композиционный слой для соединения сущностей и фич в самостоятельные блоки (например, IssuesList, UserProfile). + +[Подробнее](https://feature-sliced.design/ru/docs/get-started/overview)