refactor: перенести сборку в проекты
- перенесены каноны и VitePress-конфиги в projects/<slug> - добавлены корневой и проектные build.ts для сборки артефактов - добавлены shared-библиотеки сборки в projects/_shared/lib - обновлены CI, Dockerfile, package.json, gitignore и README - удалена сборка frontend-агента
This commit is contained in:
64
README.md
64
README.md
@@ -13,6 +13,7 @@
|
||||
- VitePress-сборка для `Template Sync Strategy`.
|
||||
- Корневой `llms.txt` как карта всех документаций.
|
||||
- Собственные `llms.txt` и `llms-full.txt` внутри каждой документации.
|
||||
- ZIP-архивы Markdown-контента для каждой документации.
|
||||
- Docker/Caddy-конфигурация для публикации статической сборки.
|
||||
- Gitea CI/CD для ветки `master`.
|
||||
|
||||
@@ -27,15 +28,16 @@
|
||||
## Структура
|
||||
|
||||
```text
|
||||
canons/ исходные материалы и черновики
|
||||
docs/slm-design/ VitePress-сайт SLM Design
|
||||
docs/nextjs-style-guide/ VitePress-сайт NextJS Style Guide
|
||||
docs/figma-adaptive-standards/ VitePress-сайт Figma Adaptive Standards
|
||||
docs/template-sync-strategy/ VitePress-сайт Template Sync Strategy
|
||||
scripts/docs/ подготовка контента для документаций
|
||||
scripts/site/ генерация корневых артефактов сайта
|
||||
src/ React-лендинг
|
||||
public/ статические файлы и сгенерированные документации
|
||||
build.ts сборка всего репозитория
|
||||
projects/<slug>/build.ts сборка конкретного проекта
|
||||
projects/<slug>/canons/ исходные Markdown-материалы проекта
|
||||
projects/<slug>/docs/ VitePress-конфигурация проекта
|
||||
projects/<slug>/scripts/ уникальные вспомогательные скрипты проекта
|
||||
projects/_shared/lib/ общие библиотечные функции сборки
|
||||
projects/_shared/docs/ общая VitePress-тема
|
||||
src/ React-лендинг
|
||||
public/ статические файлы и сгенерированные документации
|
||||
dist/ итоговая статическая сборка
|
||||
```
|
||||
|
||||
## Команды
|
||||
@@ -46,25 +48,39 @@ 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 docs:build:template-sync-strategy
|
||||
npm run site:generate
|
||||
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 docs:build:template-sync-strategy` — подготавливает и собирает VitePress-документацию Template Sync Strategy.
|
||||
- `npm run site:generate` — генерирует корневой `public/llms.txt` из `src/config/docs.config.ts` и хардкод-секций.
|
||||
- `npm run build` — генерирует корневые артефакты и собирает лендинг.
|
||||
- `npm run build` — одной командой собирает проектные документации, ZIP-архивы, корневой `llms.txt`, агентов и лендинг.
|
||||
- `npm run build:slm-design` — собирает только проект `SLM Design`.
|
||||
- `npm run build:nextjs-style-guide` — собирает только проект `NextJS Style Guide`.
|
||||
- `npm run build:figma-adaptive-standards` — собирает только проект `Figma Adaptive Standards`.
|
||||
- `npm run build:template-sync-strategy` — собирает только проект `Template Sync Strategy`.
|
||||
- `npm run app:build` — собирает React/Vite-лендинг без проектных артефактов.
|
||||
- `npm run lint` — запускает ESLint.
|
||||
|
||||
## Проекты
|
||||
|
||||
Каждая документация живёт в собственной папке `projects/<slug>` и сама владеет исходниками, конфигами и сборкой.
|
||||
|
||||
```text
|
||||
projects/slm-design/
|
||||
build.ts
|
||||
project.config.ts
|
||||
canons/
|
||||
docs/
|
||||
docs.config.ts
|
||||
.vitepress/
|
||||
scripts/
|
||||
```
|
||||
|
||||
Общая команда `npm run build` запускает корневой `build.ts`. Он последовательно вызывает `projects/<slug>/build.ts`, затем собирает общие артефакты репозитория.
|
||||
|
||||
Если скрипт является библиотечной функцией сборки, он лежит в `projects/_shared/lib`. Если скрипт уникален для проекта, он лежит в `projects/<slug>/scripts`.
|
||||
|
||||
## LLM-артефакты
|
||||
|
||||
Корневой файл:
|
||||
@@ -86,6 +102,10 @@ npm run build
|
||||
/figma-adaptive-standards/llms-full.txt
|
||||
/template-sync-strategy/llms.txt
|
||||
/template-sync-strategy/llms-full.txt
|
||||
/slm-design/slm-design.zip
|
||||
/nextjs-style-guide/nextjs-style-guide.zip
|
||||
/figma-adaptive-standards/figma-adaptive-standards.zip
|
||||
/template-sync-strategy/template-sync-strategy.zip
|
||||
```
|
||||
|
||||
Корневой `llms-full.txt` намеренно не создаётся. Полные bundles остаются внутри конкретных документаций.
|
||||
@@ -114,10 +134,6 @@ docker build -t all-docs:test .
|
||||
Docker-сборка выполняет:
|
||||
|
||||
```bash
|
||||
npm run docs:build:slm-design
|
||||
npm run docs:build:nextjs-style-guide
|
||||
npm run docs:build:figma-adaptive-standards
|
||||
npm run docs:build:template-sync-strategy
|
||||
npm run build
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user