diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 9c36fd1..aaef41a 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'; export default defineConfig({ lang: 'ru-RU', - title: 'Код-стайл React/NextJS и TypeScript', + title: 'Frontend Style Guide', description: 'Правила и стандарты разработки фронтенд-проектов на React/NextJS и TypeScript', themeConfig: { siteTitle: 'Frontend Style Guide', @@ -10,7 +10,7 @@ export default defineConfig({ { text: 'Базовые правила', items: [ - { text: 'Технологии/библиотеки', link: '/parts/1-tech-stack' }, + { text: 'Технологии и библиотеки', link: '/parts/1-tech-stack' }, { text: 'Архитектура', link: '/parts/2-architecture' }, { text: 'Стиль кода', link: '/parts/3-code-style' }, { text: 'Именование', link: '/parts/4-naming' }, diff --git a/index.md b/index.md index 88ac0a8..722599b 100644 --- a/index.md +++ b/index.md @@ -1,20 +1,10 @@ -# Код-стайл для фронтенд-проектов на React/NextJS и TypeScript +# Frontend Style Guide для проектов на React/Next.js и TypeScript -Добро пожаловать в документацию код-стайла для фронтенд-разработки. +Это набор правил и практик для разработки фронтенд-проектов: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы. -- Рекомендации охватывают архитектуру (FSD), типизацию, именование, компоненты, хуки, API, CSS и локализацию. -- Все правила и стандарты приведены в разделах слева. +## Как пользоваться -## Основные разделы +- Начните со «Технологии и библиотеки», чтобы понимать базовые допущения. +- Затем прочитайте разделы из «Базовых правил». +- При реализации используйте соответствующие прикладные разделы. -- [Ассистент](./parts/1-assistent.md) -- [Общие принципы](./parts/3-general-principles.md) -- [Архитектура](./parts/4-arkhitektura.md) -- [Стиль кода](./parts/5-code-style.md) -- [Типизация](./parts/8-typing.md) -- [Компоненты](./parts/12-components.md) -- [API](./parts/15-api.md) - ---- - -Для навигации используйте меню слева. diff --git a/parts/1-tech-stack.md b/parts/1-tech-stack.md index d3b2f73..5a943d2 100644 --- a/parts/1-tech-stack.md +++ b/parts/1-tech-stack.md @@ -1,8 +1,8 @@ --- -title: Стек технологий и библиотек +title: Технологии и библиотеки --- -# Стек технологий и библиотек +# Технологии и библиотеки Базовый стек технологий и библиотек, на который опираются проекты и примеры в документации.