Commit Graph

35 Commits

Author SHA1 Message Date
bf1781f143 docs: переработать архитектуру и прикладные разделы компонента и модуля
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 7s
- обновлена каноническая спецификация SLM Design из slm-design.gromlab.ru
- файлы архитектуры перенесены из reference/ в basics/architecture/
- добавлена предупреждающая плашка о локальной копии архитектуры
- infrastructure/ переименован в infra/ по канону спецификации
- прикладной раздел «Компонент» переписан: определение заменено ссылкой на архитектуру, добавлен пример UserStatus с типами, стилями и JSDoc
- прикладной раздел «Модуль» переписан: показаны три типа модулей (UI, бизнес, инфраструктурный), добавлен пример фабрики бизнес-модуля
- добавлен запрет ручного создания компонентов: только через кодогенератор
- обновлён раздел типизации: возвращаемый тип React-компонентов не указывается
- обновлён шаблон компонента в templates-create: суффикс -props.type.ts
- обновлены ссылки в page-level, project-structure, aliases
- сгенерированы llms.txt, llms-full.txt, README и публичные копии
2026-05-03 04:22:26 +03:00
e835210d6d docs: переработать раздел REST-клиента и стратегий получения данных
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 7s
- Добавлен обзор REST с разделением на «Создание клиента» и «Использование»
- Добавлена страница создания клиента с описанием структуры модуля
- Переписана автогенерация: npx без --swr, расширения типов вынесены в types/
- Ручной клиент сокращён до шаблона по файлам
- Добавлены GET-хуки REST-клиента с контрактом useGet..., key-функциями и isReady
- Добавлена страница выбора стратегий с приоритетом ISR перед SSR
- Добавлены стратегии: серверный await, параллельные запросы, передача промиса,
  начальные данные для клиентских хуков, клиентский GET-хук, business-композиция
- Уточнено влияние серверного await и SWR fallback на режим рендера
- Удалены устаревшие страницы fetching/server.md и fetching/client.md
- Обновлён generate-llms.ts: очистка stale-файлов перед копированием
- Обновлены сайдбар, MAP.md, data/index.md, page-level.md
2026-04-30 16:01:18 +03:00
f4e78e3227 docs: обновить прикладные разделы
All checks were successful
CI/CD Pipeline / docker (push) Successful in 1m2s
CI/CD Pipeline / deploy (push) Successful in 7s
- обновлён порядок и состав прикладных разделов
- добавлены разделы про компоненты, изображения, шрифты и локализацию
- уточнены правила модулей, страниц, сегментов и именования
- удалены устаревшие пустые разделы и обзор документации
2026-04-29 20:52:01 +03:00
c8d52e9128 docs: добавить введение для SVG-спрайтов, переименовать компоненты в модуль
Some checks failed
CI/CD Pipeline / docker (push) Failing after 8m29s
CI/CD Pipeline / deploy (push) Has been skipped
- Добавлен svg-sprites-intro.md с описанием проблем и решения
- Добавлен шаг preload спрайта в layout в настройке SVG-спрайтов
- Добавлен раздел «Дальше» в настройку SVG-спрайтов
- Исправлена ссылка на стандартный конфиг (якорь)
- components.md переименован в module.md
- Создан пустой component.md (в разработке)
- Обновлён сайдбар, MAP.md
2026-04-29 13:44:48 +03:00
9f1bc0cc32 refactor(docs): объединить setup/ и usage/ в прикладные разделы
Some checks failed
CI/CD Pipeline / docker (push) Has been cancelled
CI/CD Pipeline / deploy (push) Has been cancelled
- Директории setup/ и usage/ объединены в applied/ с подпапками для парных разделов
- Раздел «Работа с данными» вынесен на верхний уровень в data/
- Шаблоны генерации разделены на 4 файла: введение, настройка, создание, использование
- Обновлён сайдбар, CONTRIBUTING.md, MAP.md и все внутренние ссылки
- Обновлены требования и содержимое разделов (стили, шаблоны, SVG-спрайты)
2026-04-29 11:25:58 +03:00
a6cd14585b docs: ввести DEVELOP.md как точку входа архива
All checks were successful
CI/CD Pipeline / docker (push) Successful in 1m18s
CI/CD Pipeline / deploy (push) Successful in 7s
- Удалена автогенерация README.md архива (buildArchiveReadme).
- Добавлен DEVELOP.md — точка входа с обязательным порядком
  чтения: архитектура → базовые правила → прикладные по задаче.
- Добавлен MAP.md — статичная карта со ссылками на все разделы.
- DEVELOP.md и MAP.md исключены из веб-сборки (srcExclude).
- DEVELOP.md исключён из копирования в docs/public/docs/.
- Удалено копирование llms-full.txt в архив (только для сайта).
- В CONTRIBUTING.md ссылка README.md заменена на MAP.md.
2026-04-28 20:28:01 +03:00
028a69f3ac docs: переработать заголовки и описания разделов
All checks were successful
CI/CD Pipeline / docker (push) Successful in 51s
CI/CD Pipeline / deploy (push) Successful in 9s
- Зафиксированы новые правила в CONTRIBUTING.md: заголовок и описание
  как навигационный маркер, запреты, тесты и подходящие формы
- Описания во всех 26 разделах переписаны как короткий ответ на
  вопрос «когда сюда нужно?»
- Заголовки приведены к самодостаточному виду: SLM Design, SVG-спрайты,
  VS Code, Чистая установка Next.js, Источники данных, Создание
  проекта вручную, Стили, Алиасы импортов
- Описания добавлены в frontmatter (description) для согласованности
  с llms.txt и SEO
- Удалены навигационные ссылки сразу после описания
- Добавлен docs-overview.md — сводный обзор всех страниц
- Обновлён сайдбар: ссылка «Алиасы» → «Алиасы импортов»
2026-04-28 15:35:10 +03:00
a9ea898220 sync (черновик) 2026-04-28 10:52:09 +03:00
7965ec2a96 docs: актуализировать структуру разделов и заблокировать пустые
All checks were successful
CI/CD Pipeline / docker (push) Successful in 47s
CI/CD Pipeline / deploy (push) Successful in 7s
- sidebar: «Данные» поднят сразу после «Страницы (App Router)»
- sidebar: пустые разделы (Изображения, Видео, Stores, Хуки, Шрифты,
  Локализация) оставлены без link с пометкой «· в разработке»
- index.md приведён к актуальной структуре sidebar (Workflow, Базовые
  правила, Установка и настройка, Использование)
- README.md перегенерирован
2026-04-27 12:04:34 +03:00
74cbd43a23 feat: чистые URL без .html
All checks were successful
CI/CD Pipeline / docker (push) Successful in 46s
CI/CD Pipeline / deploy (push) Successful in 7s
- VitePress: включён cleanUrls
- Caddyfile: try_files пробует .html для запросов без расширения
- Caddyfile: 301-редирект /foo.html → /foo для совместимости
- sitemap.xml: канонические URL без .html
2026-04-27 10:12:30 +03:00
e265799c26 fix: устранить проблемы доступности llms.txt для AI-агентов
All checks were successful
CI/CD Pipeline / docker (push) Successful in 51s
CI/CD Pipeline / deploy (push) Successful in 8s
- Caddyfile: text/plain применяется только к существующим .txt/.md
- Caddyfile: несуществующие .txt/.md отдают 404 вместо HTML-фолбэка
- Caddyfile: добавлены редиректы /docs/llms*.txt → /llms*.txt
- Caddyfile: добавлен HTTP-заголовок Link с rel="llms" (RFC 8288)
- лендинг: относительные ссылки на llms.txt заменены на абсолютные
- лендинг: добавлено явное упоминание путей в тексте карточки
- config: добавлены <link rel="alternate"> на llms.txt в <head>
- generate-llms: добавлена генерация robots.txt и sitemap.xml
2026-04-27 09:37:23 +03:00
781efc52f1 docs: добавить разделы установки проекта, Next.js, стилей и шаблонов
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 5s
- Создание проекта: «Из шаблона» (clone через tiged) и «Вручную» (пошаговая сборка) — оформлены подгруппой
- Next.js: `create-next-app` с каноническими флагами, очистка демо-шаблона, минимальный layout
- Стили: базовая инфраструктура `variables.css` / `media.css` / `global.css` в `src/shared/styles/` без PostCSS
- Шаблоны генерации: установка `.templates/` через tiged + создание шаблона вручную
- Сайдбар «Установка и настройка» расширен новыми пунктами в порядке зависимости установки
2026-04-27 01:27:43 +03:00
3d93efd90a docs: добавить раздел «Данные» и реорганизовать документацию
All checks were successful
CI/CD Pipeline / docker (push) Successful in 44s
CI/CD Pipeline / deploy (push) Successful in 6s
- Добавлен раздел «Данные»: REST (автоматическая и ручная генерация клиентов, получение данных в server и client компонентах с инкапсуляцией SWR в хуках), Realtime, введение
- Прикладные разделы переименованы в «Использование», папка перенесена в `docs/docs/usage/`
- Создана группа «Установка и настройка» с папкой `docs/docs/setup/` — туда вынесены PostCSS, Biome, VS Code, алиасы и установка SVG-спрайтов
- Подгруппы «Стили» и «SVG-спрайты» в сайдбаре упразднены — страницы установки и использования разнесены по верхнеуровневым группам
- Удалён устаревший раздел `applied/api.md`
- Перекрёстные ссылки в workflow-разделах и внутри новых страниц синхронизированы с новыми путями
- CONTRIBUTING.md обновлён под новую структуру папок
2026-04-27 00:54:26 +03:00
e5e4ace91a docs: добавить раздел «Алиасы»
All checks were successful
CI/CD Pipeline / docker (push) Successful in 46s
CI/CD Pipeline / deploy (push) Successful in 6s
- Добавлен прикладной раздел с конфигом tsconfig.paths и правилами использования
- Зафиксирован отказ от префикса @/
- Пункт «Алиасы» добавлен в сайдбар после «Структуры проекта»
2026-04-26 23:00:00 +03:00
5a773a5b4f docs: добавить разделы biome, svg-спрайтов и сгруппировать стили
- Добавлен раздел «Biome» в прикладные разделы
- Раздел «SVG-спрайты» преобразован в группу: установка, использование
- Раздел «Стили» преобразован в группу: PostCSS, использование
- Обновлён сайдбар VitePress с новыми группами
- Перегенерирован README из главной страницы документации
2026-04-26 22:50:51 +03:00
f645b2ad40 refactor: удалить английскую локаль и упростить структуру
All checks were successful
CI/CD Pipeline / docker (push) Successful in 48s
CI/CD Pipeline / deploy (push) Successful in 7s
- Удалена английская версия документации (docs/en/) и артефакты en
- Контент перенесён docs/ru/ → docs/docs/, URL /ru/ заменён на /docs/
- Из .vitepress/config.ts убраны locales и enSidebar, оставлен один sidebar
- Из лендинга удалён переключатель языка ru/en и en-словарь
- generate-llms.ts переписан без параметра lang; llms.txt, llms-full.txt
  и nextjs-style-guide.zip генерируются в корень docs/public/
- README_RU.md занял место корневого README.md
- Обновлены CONTRIBUTING.md, custom.css, комментарий в Dockerfile
2026-04-26 15:04:10 +03:00
5cf0f0f8ba fix: переключатель языка и иконка репозитория в шапке
- восстановлены link для локалей: ru → /ru/, en → /en/ (были сломаны на /)
- добавлена иконка GitHub в socialLinks шапки VitePress для ru и en
  со ссылкой на https://gromlab.ru/docs/nextjs-style-guide
- root-локаль скрыта из переключателя языка через CSS (display: none
  для href="/"): в дропдауне теперь только Русский и English
- pill-кнопка «Репозиторий» добавлена в блок controls лендинга
  с иконкой GitHub, открывается в новой вкладке
- мобильная вёрстка лендинга переработана: контролы стопкой,
  репозиторий на ≤480px сжимается до иконки 36x36, увеличены
  отступы между блоками (hero / controls / cards) для разделения
2026-04-25 21:14:17 +03:00
ae103e962e feat: llms-full.txt, README архива и доработка лендинга
All checks were successful
CI/CD Pipeline / docker (push) Successful in 46s
CI/CD Pipeline / deploy (push) Successful in 8s
- добавлен генератор llms-full.txt: вся документация локали в одном
  файле с мета-якорями, порядок повторяет sidebar
- архив теперь содержит README.md как точку входа: карта документации
  с относительными ссылками, описаниями и метаинфо сборки
- ссылки /ru/... в .md-файлах архива преобразуются в относительные
  пути (через path.relative) — внутренняя навигация работает локально
- веб-index.md удаляется из архива (его роль выполняет README.md)
- llms-full.txt добавлен в архив для одноразового чтения LLM
- в sidebar добавлен пункт «Главная» / «Home» со ссылкой на корень локали
- карточка «Ассистенту» на лендинге: две кнопки llms.txt и llms-full.txt
  с открытием в новой вкладке
- активирована карточка «Скачать правила» (ru) с ссылкой на zip-архив
- удалён устаревший блок «Для ассистентов» из docs/{ru,en}/index.md
- обновлены описания на главных локалей и заменён FSD на SLM в EN
- в манифесте появилось поле llmsFull рядом с llms
2026-04-25 19:56:44 +03:00
99c0995cb6 feat: генерация llms.txt, лендинг с выбором языка и ZIP-архивов
All checks were successful
CI/CD Pipeline / docker (push) Successful in 1m10s
CI/CD Pipeline / deploy (push) Successful in 8s
- удалён concat-md.js: вместо единого RULES.md теперь llms.txt
- добавлен generate-llms.ts: собирает llms.txt из sidebar config, копирует
  .md-файлы для отдачи LLM и упаковывает ZIP-архивы по локалям
- добавлен корневой /llms.txt как роутер на /ru/llms.txt и /en/llms.txt
- добавлен манифест /manifest.json со ссылками и версией сборки
- добавлен лендинг docs/index.md (layout: false) с автоопределением
  языка, переключателями языка и темы
- английская локаль временно заблокирована: карточки как заглушки,
  ссылка на /en/ в роутере без href
- добавлены поля llmsBlockquote и llmsContext в локали для
  технодокументационного описания в llms.txt
- разделены VitePress-локали: root (только лендинг), ru (/ru/), en (/en/)
- добавлен srcExclude: ['public/**'] чтобы VitePress не рендерил
  сгенерированные .md как страницы
- добавлен Vite-плагин для отдачи .txt и .md с charset=utf-8
- добавлена секция в Caddyfile для текстовых файлов
- BUILD_VERSION пробрасывается из Gitea CI через docker --build-arg
  и подставляется в лендинг через Vite define
- Dockerfile: установка zip, npm run llms перед npm run build
- обновлены внутренние ссылки в docs/ru/**/*.md на префикс /ru/
- обновлены AGENTS.md и CONTRIBUTING.md под новый процесс
- README/README_RU генерируются из docs/{lang}/index.md, остаются в репо
2026-04-25 18:06:27 +03:00
d621e6b57d fix: Баз с раскрытием вложенной навигации
All checks were successful
CI/CD Pipeline / docker (push) Successful in 43s
CI/CD Pipeline / deploy (push) Successful in 8s
2026-04-20 16:56:27 +03:00
787223010f style: свернуть подпункты архитектуры в сайдбаре по умолчанию
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 6s
2026-04-20 11:44:27 +03:00
f5732904f4 refactor(architecture): декомпозировать раздел на 4 файла
All checks were successful
CI/CD Pipeline / docker (push) Successful in 39s
CI/CD Pipeline / deploy (push) Successful in 7s
- architecture.md разбит на architecture/index.md + reference/layers.md, modules.md, segments.md
- добавлена вложенность в сайдбар (Слои, Модули, Сегменты)
- обновлён fileOrder в concat-md.js для 4 файлов
- исправлены dead links на /basics/architecture (добавлен слеш)
- перегенерированы RULES.md и README
2026-04-20 11:40:49 +03:00
e608017dce chore: удалить кэш VitePress из отслеживания git
- удалены файлы .vitepress/cache из индекса (правило в .gitignore уже существовало, но файлы были закоммичены ранее)
2026-04-01 10:38:16 +03:00
29bcf23dde docs: переработать компоненты, структуру проекта и документирование
- переработан раздел «Компоненты»: добавлены правила организации, типизации, реализации
- переработан раздел «Структура проекта»: упрощён, добавлены корень репозитория и конфиг-файлы
- переработан раздел «Документирование»: добавлены шаблоны для функций, компонентов, типов
- обновлён CONTRIBUTING.md: добавлены секции Workflow и Чеклист, правила разделены на Реализацию и Организацию
- перенесены типы компонентов из «Типизации» в «Компоненты»
- обновлён шаблон генерации: деструктуризация пропсов в теле, children вместо текста
- добавлен SCREAMING_SNAKE_CASE для ключей enum в «Именование»
- перемещён «Настройка VS Code» в конец сайдбара
- обновлён порядок файлов в concat-md.js и перегенерирован RULES.md
2026-04-01 10:35:07 +03:00
c46b843670 chore: переместить 'Именование' после 'Технологии' в сайдбаре и конкатенации
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 8s
2026-03-31 15:18:08 +03:00
bc01cb930a docs: переименованы разделы прикладных секций, удалён «Начало работы»
- Компоненты → UI и компоненты
- Page-level компоненты → Страницы (App Router)
- Удалён раздел «Начало работы» из workflow
- Обновлены sidebar, заголовки md-файлов и RULES.md
2026-03-29 18:55:12 +03:00
93684be5bd chore: обновлены конфиги под единый файл workflow
- Заменена группа из 9 пунктов Workflow в sidebar на одну ссылку
- Обновлён concat-md.js: 9 файлов воркфлоу заменены на workflow.md
2026-03-29 14:04:19 +03:00
b104ca6581 docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md
All checks were successful
CI/CD Pipeline / docker (push) Successful in 45s
CI/CD Pipeline / deploy (push) Successful in 7s
- Переработан раздел Workflow: заголовки, описания, порядок разделов
- Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied)
- Убран суффикс .ui.tsx из документации и примеров
- Переработан раздел Структура проекта — только Next.js, без React SPA
- Приоритет стилизации перенесён из applied/styles в workflow/styling
- Убрано дублирование инструментов генерации — единая точка в applied/templates-generation
- Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md
- Удалена зависимость concat-md
- Обновлена главная страница: названия разделов, URL на RULES.md
- Добавлен AGENTS.md с правилами для агентов
2026-03-29 11:43:23 +03:00
b37eb75542 sync
Some checks failed
CI/CD Pipeline / docker (push) Failing after 12m36s
CI/CD Pipeline / deploy (push) Has been cancelled
2026-03-28 21:15:15 +03:00
a9f91dae29 sync
Some checks failed
CI/CD Pipeline / docker (push) Failing after 2m7s
CI/CD Pipeline / deploy (push) Has been skipped
2026-03-23 21:48:54 +03:00
d1af4619f7 sync
Some checks failed
CI/CD Pipeline / docker (push) Failing after 2m16s
CI/CD Pipeline / deploy (push) Has been skipped
2026-03-18 09:22:03 +03:00
9eeba2c37d sync
All checks were successful
CI/CD Pipeline / docker (push) Successful in 43s
CI/CD Pipeline / deploy (push) Successful in 7s
2026-02-01 13:15:00 +03:00
f525c4f8ae sync 2026-01-30 12:14:53 +03:00
06adcca9d9 sync 2026-01-29 16:18:06 +03:00
7e2dea74ef sync 2026-01-29 16:00:19 +03:00