feat: добавить документацию NextJS Style Guide
- добавлен отдельный VitePress-сайт для NextJS Style Guide - удалены дубли SLM-канонов из style-guide - обновлены ссылки, сборочные скрипты, CI, Docker и README - разблокирована карточка NextJS Style Guide на главной
This commit is contained in:
18
README.md
18
README.md
@@ -8,6 +8,8 @@
|
||||
|
||||
- React/Vite-лендинг со списком документаций.
|
||||
- VitePress-сборка для `SLM Design`.
|
||||
- VitePress-сборка для `NextJS Style Guide`.
|
||||
- VitePress-сборка для `Figma Adaptive Standards`.
|
||||
- Корневой `llms.txt` как карта всех документаций.
|
||||
- Собственные `llms.txt` и `llms-full.txt` внутри каждой документации.
|
||||
- Docker/Caddy-конфигурация для публикации статической сборки.
|
||||
@@ -16,15 +18,17 @@
|
||||
## Документации
|
||||
|
||||
- `SLM Design` — архитектура frontend-приложений через слои, модули, публичные API и DI через фабрики.
|
||||
- `NextJS Style Guide` — будущие правила организации Next.js-приложений.
|
||||
- `NextJS Style Guide` — практический стайлгайд для разработки frontend-приложений на Next.js и TypeScript.
|
||||
- `React Style Guide` — будущие правила написания React-кода.
|
||||
- `Figma Adaptive Standards` — будущие стандарты подготовки адаптивных макетов в Figma.
|
||||
- `Figma Adaptive Standards` — стандарты подготовки адаптивных макетов в Figma.
|
||||
|
||||
## Структура
|
||||
|
||||
```text
|
||||
canons/ исходные материалы и черновики
|
||||
docs/slm-design/ VitePress-сайт SLM Design
|
||||
docs/nextjs-style-guide/ VitePress-сайт NextJS Style Guide
|
||||
docs/figma-adaptive-standards/ VitePress-сайт Figma Adaptive Standards
|
||||
scripts/docs/ подготовка контента для документаций
|
||||
scripts/site/ генерация корневых артефактов сайта
|
||||
src/ React-лендинг
|
||||
@@ -40,6 +44,8 @@ npm run dev
|
||||
|
||||
```bash
|
||||
npm run docs:build:slm-design
|
||||
npm run docs:build:nextjs-style-guide
|
||||
npm run docs:build:figma-adaptive-standards
|
||||
npm run site:generate
|
||||
npm run build
|
||||
```
|
||||
@@ -48,6 +54,8 @@ npm run build
|
||||
|
||||
- `npm run dev` — запускает Vite dev server.
|
||||
- `npm run docs:build:slm-design` — подготавливает и собирает VitePress-документацию SLM Design.
|
||||
- `npm run docs:build:nextjs-style-guide` — подготавливает и собирает VitePress-документацию NextJS Style Guide.
|
||||
- `npm run docs:build:figma-adaptive-standards` — подготавливает и собирает VitePress-документацию Figma Adaptive Standards.
|
||||
- `npm run site:generate` — генерирует корневой `public/llms.txt` из `src/config/docs.config.ts` и хардкод-секций.
|
||||
- `npm run build` — генерирует корневые артефакты и собирает лендинг.
|
||||
- `npm run lint` — запускает ESLint.
|
||||
@@ -67,6 +75,10 @@ npm run build
|
||||
```text
|
||||
/slm-design/llms.txt
|
||||
/slm-design/llms-full.txt
|
||||
/nextjs-style-guide/llms.txt
|
||||
/nextjs-style-guide/llms-full.txt
|
||||
/figma-adaptive-standards/llms.txt
|
||||
/figma-adaptive-standards/llms-full.txt
|
||||
```
|
||||
|
||||
Корневой `llms-full.txt` намеренно не создаётся. Полные bundles остаются внутри конкретных документаций.
|
||||
@@ -95,6 +107,8 @@ Docker-сборка выполняет:
|
||||
|
||||
```bash
|
||||
npm run docs:build:slm-design
|
||||
npm run docs:build:nextjs-style-guide
|
||||
npm run docs:build:figma-adaptive-standards
|
||||
npm run build
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user