4 Commits

Author SHA1 Message Date
1a1de7cad4 fix: исправить доступность артефактов документации
All checks were successful
CI/CD Pipeline / build (push) Successful in 16s
CI/CD Pipeline / version (push) Successful in 4s
CI/CD Pipeline / docker (push) Successful in 43s
CI/CD Pipeline / deploy (push) Successful in 7s
- добавлены HTML-подсказки для обнаружения llms.txt агентами
- обновлена карточка скачивания спецификации и архива
- добавлен раздел с порядком чтения спецификации
- исправлена генерация ссылок для single-file, Markdown и ZIP
- обновлены сгенерированные README.md и ARCHITECTURE.md
2026-05-02 18:51:44 +03:00
07542330b5 fix: исправить ссылки llms на markdown-файлы
All checks were successful
CI/CD Pipeline / build (push) Successful in 16s
CI/CD Pipeline / version (push) Successful in 4s
CI/CD Pipeline / docker (push) Successful in 42s
CI/CD Pipeline / deploy (push) Successful in 6s
- обновлены ссылки llms.txt на доступные .md-файлы
- добавлено копирование markdown-файлов в публичную статику
- исключена docs/public из сканирования VitePress и индекса Git
- добавлена пометка для локальной копии ARCHITECTURE.md
2026-05-02 06:53:35 +03:00
245dbbe302 chore: обновить правила отдачи документации
All checks were successful
CI/CD Pipeline / build (push) Successful in 16s
CI/CD Pipeline / version (push) Successful in 4s
CI/CD Pipeline / docker (push) Successful in 41s
CI/CD Pipeline / deploy (push) Successful in 5s
- добавлены редиректы для устаревших путей llms
- добавлен редирект HTML-страниц на чистые URL
- добавлена защита текстовых артефактов от SPA-фолбэка
- включены чистые URL в конфигурации VitePress
2026-05-01 23:57:56 +03:00
ee5b947fb0 fix: заменить cache-busting через query на Cache-Control заголовок (#6)
All checks were successful
CI/CD Pipeline / build (push) Successful in 17s
CI/CD Pipeline / version (push) Successful in 4s
CI/CD Pipeline / docker (push) Successful in 1m4s
CI/CD Pipeline / deploy (push) Successful in 7s
fix: заменить cache-busting через query на Cache-Control заголовок

- Убран query-параметр ?v= из ссылки на ARCHITECTURE.md
- Добавлен заголовок Cache-Control: no-cache для ARCHITECTURE.md в Caddyfile

Reviewed-on: #6
Co-authored-by: S.Gromov <zz-gromov@ya.ru>
Co-committed-by: S.Gromov <zz-gromov@ya.ru>
2026-05-01 21:42:36 +03:00
10 changed files with 231 additions and 31 deletions

2
.gitignore vendored
View File

@@ -135,6 +135,7 @@ dist
.vitepress/cache
.vitepress/dist
docs/.vitepress
docs/public/
# Generated artifacts
public/docs/
@@ -149,4 +150,3 @@ dist
# Рабочие заметки
notes

View File

@@ -14,10 +14,18 @@ const sidebar = [
export default defineConfig({
srcDir: 'docs',
srcExclude: ['public/**'],
outDir: 'public/docs',
title: 'SLM Design',
description: 'Правила и стандарты архитектуры проекта',
base: '/docs/',
cleanUrls: true,
head: [
['meta', { name: 'llms', content: '/llms.txt' }],
['link', { rel: 'alternate llms', type: 'text/plain', href: '/llms.txt', title: 'llms.txt' }],
['link', { rel: 'alternate', type: 'text/plain', href: '/llms-full.txt', title: 'llms-full.txt' }],
['link', { rel: 'alternate', type: 'text/markdown', href: '/ARCHITECTURE.md', title: 'ARCHITECTURE.md' }],
],
themeConfig: {
sidebar,

View File

@@ -1,11 +1,40 @@
:8082 {
root * /srv
@plainText path /llms.txt /llms-full.txt
header @plainText Content-Type "text/plain; charset=utf-8"
@markdown path /ARCHITECTURE.md
header @markdown Content-Type "text/markdown; charset=utf-8"
header @markdown Cache-Control "no-cache, no-store, must-revalidate"
file_server
# Устаревшие пути llms.txt в подпапках ведём к корневым артефактам.
redir /docs/llms.txt /llms.txt 301
redir /docs/llms-full.txt /llms-full.txt 301
# Чистые URL: запросы вида `/docs/foo.html` редиректим на `/docs/foo`.
@legacyHtml {
path_regexp legacyHtml ^(/.+)\.html$
not path /index.html
}
redir @legacyHtml {re.legacyHtml.1} 301
header Link "</llms.txt>; rel=\"llms\""
@existingText {
path *.txt
file
}
header @existingText Content-Type "text/plain; charset=utf-8"
@existingMarkdown {
path *.md
file
}
header @existingMarkdown Content-Type "text/markdown; charset=utf-8"
@architecture path /ARCHITECTURE.md
header @architecture Cache-Control "no-cache, no-store, must-revalidate"
@missingText {
path *.txt *.md
not file
}
respond @missingText 404
file_server
try_files {path} {path}.html {path}/index.html /index.html
}

View File

@@ -1,6 +1,16 @@
# SLM Design
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
## Разделы спецификации
Спецификация SLM Design состоит из нескольких связанных разделов. Этот обзор даёт общий контекст, а детальные правила описаны дальше:
- [Слои](docs/architecture/layers.md) — уровни организации `src/`, направление зависимостей и зона ответственности каждого слоя.
- [Модули](docs/architecture/modules.md) — границы ответственности, публичный API, типы модулей и отличие модуля от компонента.
- [Сегменты](docs/architecture/segments.md) — внутренние папки модуля (`ui/`, `parts/`, `hooks/`, `types/` и другие) и правила размещения файлов.
Рекомендуемый порядок чтения: обзор → слои → модули → сегменты.
## Преимущества
### Вертикальная организация домена

View File

@@ -6,6 +6,16 @@ description: Назначение архитектуры, ключевые пр
# SLM Design
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
## Разделы спецификации
Спецификация SLM Design состоит из нескольких связанных разделов. Этот обзор даёт общий контекст, а детальные правила описаны дальше:
- [Слои](/architecture/layers) — уровни организации `src/`, направление зависимостей и зона ответственности каждого слоя.
- [Модули](/architecture/modules) — границы ответственности, публичный API, типы модулей и отличие модуля от компонента.
- [Сегменты](/architecture/segments) — внутренние папки модуля (`ui/`, `parts/`, `hooks/`, `types/` и другие) и правила размещения файлов.
Рекомендуемый порядок чтения: обзор → слои → модули → сегменты.
## Преимущества
### Вертикальная организация домена

View File

@@ -5,7 +5,12 @@ import { execFileSync } from "child_process";
const SRC_DIR = "./docs";
const PUBLIC_DIR = "./public";
const DOCS_PUBLIC_DIR = path.join(SRC_DIR, "public");
const DOC_ROUTE_PREFIX = "/docs";
const PUBLIC_ARCHITECTURE_FILE = "ARCHITECTURE.md";
const PUBLIC_ARCHITECTURE_NOTICE = `> Локальная копия канонической спецификации SLM Design.
> Источник: https://slm-design.gromlab.ru/ARCHITECTURE.md
> Не редактировать вручную в этом проекте.`;
interface SidebarItem {
text: string;
@@ -43,15 +48,54 @@ function parseSidebar(): SidebarGroup[] {
const SIDEBAR = parseSidebar();
function linkToFileRel(link: string): string {
const rel = link.replace(/^\//, "");
if (rel === "" || rel.endsWith("/")) return `${rel}index.md`;
return `${rel}.md`;
}
function fileRelToRoute(file: string): string {
const route = file.endsWith("/index.md")
? file.replace(/index\.md$/, "")
: file.replace(/\.md$/, "");
return `${DOC_ROUTE_PREFIX}/${route}`;
}
function fileRelToMdUrl(file: string): string {
return `${DOC_ROUTE_PREFIX}/${file}`;
}
const ARCHITECTURE_LINK_RE = /\]\((\/architecture(?:\/[^)\s#]*)?)(#[^)\s]*)?\)/g;
function architectureRouteToFileRel(route: string): string {
if (route.replace(/\/$/, "") === "/architecture") return "architecture/index.md";
return linkToFileRel(route);
}
function transformArchitectureLinks(
content: string,
toHref: (route: string, hash: string) => string,
): string {
return content.replace(ARCHITECTURE_LINK_RE, (_match, route: string, hash = "") => {
return `](${toHref(route, hash)})`;
});
}
function transformArchiveLinks(content: string): string {
return transformArchitectureLinks(content, (route, hash) => {
const fileName = path.basename(architectureRouteToFileRel(route));
return `./${fileName}${hash}`;
});
}
function transformSiteMarkdownLinks(content: string): string {
return transformArchitectureLinks(content, (route, hash) => {
return `${fileRelToMdUrl(architectureRouteToFileRel(route))}${hash}`;
});
}
function getAllFiles(): string[] {
return SIDEBAR.flatMap((g) =>
g.items.map((item) => {
const rel = item.link.replace(/^\//, "") + ".md";
const indexPath = rel.replace(/\.md$/, "/index.md");
const filePath = path.join(SRC_DIR, indexPath);
return fs.existsSync(filePath) ? indexPath : rel;
})
);
return SIDEBAR.flatMap((g) => g.items.map((item) => linkToFileRel(item.link)));
}
const stripFrontmatter = (content: string) =>
@@ -60,6 +104,38 @@ const stripFrontmatter = (content: string) =>
const stripRulesLink = (content: string) =>
content.replace(/<!-- rules-link -->[\s\S]*?<!-- \/rules-link -->\n*/g, "");
function slugifyHeading(heading: string): string {
return heading
.trim()
.replace(/[`*_~[\]()]/g, "")
.toLowerCase()
.replace(/[^\p{L}\p{N}\s-]/gu, "")
.trim()
.replace(/\s+/g, "-");
}
function fileRelToSingleFileAnchor(file: string): string {
const filePath = path.join(SRC_DIR, file);
if (!fs.existsSync(filePath)) return slugifyHeading(path.basename(file, ".md"));
const raw = stripFrontmatter(fs.readFileSync(filePath, "utf8"));
const title = raw.match(/^#\s+(.+)$/m)?.[1];
return slugifyHeading(title ?? path.basename(file, ".md"));
}
function transformSingleFileLinks(content: string): string {
return transformArchitectureLinks(content, (route, hash) => {
if (hash) return hash;
return `#${fileRelToSingleFileAnchor(architectureRouteToFileRel(route))}`;
});
}
function transformReadmeLinks(content: string): string {
return transformArchitectureLinks(content, (route, hash) => {
return `docs/${architectureRouteToFileRel(route)}${hash}`;
});
}
const shiftHeadings = (content: string) => {
const lines = content.split("\n");
let inCodeBlock = false;
@@ -84,8 +160,9 @@ const buildArchitectureMarkdown = (routePrefix: string) => {
const content = stripRulesLink(stripFrontmatter(raw)).trim();
if (!content) continue;
const route = routePrefix + "/" + file.replace(/\.md$/, "");
const processed = file.endsWith("index.md") ? content : shiftHeadings(content);
const route = routePrefix + fileRelToRoute(file).replace(DOC_ROUTE_PREFIX, "");
const shifted = file.endsWith("index.md") ? content : shiftHeadings(content);
const processed = transformSingleFileLinks(shifted);
parts.push(`<!-- ${route} -->\n${processed}`);
}
@@ -99,9 +176,7 @@ function buildLlms() {
for (const group of SIDEBAR) {
parts.push(`## ${group.text}`);
for (const item of group.items) {
const rel = item.link.replace(/^\//, "") + ".md";
const indexPath = rel.replace(/\.md$/, "/index.md");
const fileRel = fs.existsSync(path.join(SRC_DIR, indexPath)) ? indexPath : rel;
const fileRel = linkToFileRel(item.link);
const filePath = path.join(SRC_DIR, fileRel);
let desc = "";
if (fs.existsSync(filePath)) {
@@ -109,7 +184,7 @@ function buildLlms() {
const fm = raw.match(/^---[\s\S]*?---\n*/m);
desc = fm ? fm[0].match(/description:\s*(.+)/)?.[1] || "" : "";
}
const route = "/docs" + item.link;
const route = fileRelToMdUrl(fileRel);
const line = desc
? `- [${item.text}](${route}): ${desc}`
: `- [${item.text}](${route})`;
@@ -130,10 +205,29 @@ function buildLlmsFull() {
console.log(`llms-full.txt создан: ${outPath}`);
}
function copyMarkdownFiles() {
fs.rmSync(DOCS_PUBLIC_DIR, { recursive: true, force: true });
let copied = 0;
for (const file of getAllFiles()) {
const src = path.join(SRC_DIR, file);
if (!fs.existsSync(src)) continue;
const content = transformSiteMarkdownLinks(fs.readFileSync(src, "utf8"));
const dest = path.join(DOCS_PUBLIC_DIR, file);
fs.mkdirSync(path.dirname(dest), { recursive: true });
fs.writeFileSync(dest, content, "utf8");
copied++;
}
console.log(`скопировано ${copied} .md-файлов в ${DOCS_PUBLIC_DIR}`);
}
function buildPublicArchitecture() {
const outPath = path.join(PUBLIC_DIR, PUBLIC_ARCHITECTURE_FILE);
const content = `${PUBLIC_ARCHITECTURE_NOTICE}\n\n${buildArchitectureMarkdown("/docs")}`;
fs.mkdirSync(PUBLIC_DIR, { recursive: true });
fs.writeFileSync(outPath, buildArchitectureMarkdown("/docs"), "utf8");
fs.writeFileSync(outPath, content, "utf8");
console.log(`${PUBLIC_ARCHITECTURE_FILE} создан: ${outPath}`);
}
@@ -148,6 +242,7 @@ function buildZip() {
if (!fs.existsSync(src)) continue;
let content = fs.readFileSync(src, "utf8");
content = stripRulesLink(stripFrontmatter(content)).trim();
content = transformArchiveLinks(content);
const destName = path.basename(file);
fs.writeFileSync(path.join(tmpDir, destName), content, "utf8");
}
@@ -174,12 +269,14 @@ function buildReadme() {
let content = stripFrontmatter(fs.readFileSync(indexPath, "utf8"));
content = content.replace(/<!-- rules-link -->[\s\S]*?<!-- \/rules-link -->\n*/g, "");
content = transformReadmeLinks(content);
fs.writeFileSync("./README.md", content, "utf8");
console.log("README.md создан");
}
buildLlms();
buildLlmsFull();
copyMarkdownFiles();
buildPublicArchitecture();
buildZip();
buildReadme();

View File

@@ -5,10 +5,28 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SLM Design</title>
<meta name="description" content="Scoped Layered Module Design — модульная архитектура фронтенд-приложений" />
<meta name="llms" content="/llms.txt" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<link rel="alternate llms" type="text/plain" href="/llms.txt" title="llms.txt" />
<link rel="alternate" type="text/plain" href="/llms-full.txt" title="llms-full.txt" />
<link rel="alternate" type="text/markdown" href="/ARCHITECTURE.md" title="ARCHITECTURE.md" />
</head>
<body>
<div id="root"></div>
<div id="root">
<main>
<h1>SLM Design</h1>
<p>Scoped Layered Module Design — модульная архитектура фронтенд-приложений.</p>
<nav aria-label="Карта сайта и AI-артефакты">
<ul>
<li><a href="/docs/">Документация</a></li>
<li><a href="/llms.txt" rel="alternate" type="text/plain">llms.txt</a></li>
<li><a href="/llms-full.txt" rel="alternate" type="text/plain">llms-full.txt</a></li>
<li><a href="/ARCHITECTURE.md" rel="alternate" type="text/markdown">ARCHITECTURE.md</a></li>
<li><a href="/slm-design.zip" download>slm-design.zip</a></li>
</ul>
</nav>
</main>
</div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>

View File

@@ -1,7 +1,21 @@
<!-- /docs/architecture//index -->
> Локальная копия канонической спецификации SLM Design.
> Источник: https://slm-design.gromlab.ru/ARCHITECTURE.md
> Не редактировать вручную в этом проекте.
<!-- /docs/architecture/ -->
# SLM Design
Scoped Layered Module Design — модульная архитектура фронтенд-приложений. Код организован по слоям ответственности, а модуль содержит всё, что ему нужно: компоненты, хуки, сторы, типы, стили.
## Разделы спецификации
Спецификация SLM Design состоит из нескольких связанных разделов. Этот обзор даёт общий контекст, а детальные правила описаны дальше:
- [Слои](#слои) — уровни организации `src/`, направление зависимостей и зона ответственности каждого слоя.
- [Модули](#модули) — границы ответственности, публичный API, типы модулей и отличие модуля от компонента.
- [Сегменты](#сегменты) — внутренние папки модуля (`ui/`, `parts/`, `hooks/`, `types/` и другие) и правила размещения файлов.
Рекомендуемый порядок чтения: обзор → слои → модули → сегменты.
## Преимущества
### Вертикальная организация домена
@@ -494,7 +508,7 @@ backend-api/
└── index.ts # публичный API
```
Подробное описание сегментов — в разделе [Сегменты](/architecture/segments).
Подробное описание сегментов — в разделе [Сегменты](#сегменты).
### Публичный API
@@ -671,7 +685,7 @@ export const HomeScreen = () => {
- Не получает данные самостоятельно, не выбирает источник данных и не композирует данные.
- Не содержит бизнес-логику или сценарную логику.
Если UI-сущности нужно что-то за пределами этих ограничений, она должна быть оформлена как модуль. Полная граница описана в разделе [Компонент](/architecture/modules#компонент).
Если UI-сущности нужно что-то за пределами этих ограничений, она должна быть оформлена как модуль. Полная граница описана в разделе [Компонент](#компонент).
Корневой файл модуля в `ui/` не размещается. Он лежит в корне модуля: `{module-name}.tsx`.

View File

@@ -8,10 +8,19 @@ export const homeCards = [
cta: 'Открыть →',
},
{
title: 'ARCHITECTURE.md',
description: 'Полная версия архитектуры в одном файле',
href: '/ARCHITECTURE.md',
cta: 'Открыть →',
title: 'Скачать',
description: 'Локальная копия спецификации и архив документации.',
actions: [
{
href: '/ARCHITECTURE.md',
label: 'ARCHITECTURE.md',
},
{
href: '/slm-design.zip',
label: 'slm-design.zip',
download: true,
},
],
},
{
title: 'Ассистенту',

View File

@@ -48,7 +48,12 @@ export function HomeScreen() {
<p>{card.description}</p>
<div className={styles.cardActions}>
{card.actions.map((action) => (
<a className={styles.cardAction} href={action.href} key={action.href}>
<a
className={styles.cardAction}
download={'download' in action ? action.download : undefined}
href={action.href}
key={action.href}
>
{action.label}
</a>
))}