chore(docs): уборка структуры — вся документация в docs/, краткий README, добавлен AGENTS.md

- AGENTS.md: правила проекта (структура доков, стек, статьи, деплой, git, openspec, проверки) - README.md: сокращён до введения + указателей на docs/ - docs/: DEPLOY_INSTRUCTIONS, ROADMAP, PAPERMOD_PARAMS, QWEN, gitea-setup, Telegram_frontend, ssh_setup, archive/PROJECT_SUMMARY (из .qwen/) - tools/: winscp_script.txt переехал из корня к deploy_sftp.py - Makefile и deploy_sftp.py: ссылки на docs/DEPLOY_INSTRUCTIONS.md
2026-09-12 09:58:09 +00:00
parent 80eb3c709d
commit d426aa39ed
13 changed files with 145 additions and 103 deletions
@@ -1,100 +1,55 @@
 # dedinit.ru

-## Описание проекта
+**dedinit.ru** — блог на генераторе статических сайтов [Hugo](https://gohugo.io)
+(extended) с кастомной темой **rDedInit** (форк [PaperMod](https://github.com/adityatelange/hugo-PaperMod)).
+Платформа для публикации лонгридов с поддержкой блоков кода и подсветки
+синтаксиса.

-Этот проект представляет собой блог на основе генератора статических сайтов Hugo с темой PaperMod. Основная цель проекта - создать платформу для публикации лонгридов с поддержкой блоков кода и подсветки синтаксиса, чего не хватает в других сервисах (Telegraph, VK, Writefreely).
+## Быстрый старт

-## Технические детали
-
- Генератор статических сайтов: Hugo (расширенная версия)
- Тема оформления: PaperMod (<https://github.com/adityatelange/hugo-PaperMod>)
- Хранение контента: GitVerse (<gitverse.ru:kpa39l/dedinit.ru>) через SSH
- Настройка: bundle хранение статей
-
-## Статус проекта
-
-Проект находится в стадии разработки. Выполненные задачи:
-
- Установлена Hugo расширенная версия (0.155.1)
- Создан новый сайт dedinit.ru
- Установлена и настроена тема PaperMod
- Настроено bundle хранение статей
- Решена проблема совместимости Hugo и темы PaperMod
- Репозиторий подключён к GitVerse (gitverse.ru:kpa39l/dedinit.ru)
- **Создана собственная тема rDedInit** на базе PaperMod
-
-## История изменений
-
-### 30 августа 2026 года
-
- Написана и опубликована статья «Как я перевёл aux-задачи Hermes на локальные модели» (пост `20260830 - local aux models hermes`, slug `local-aux-models-hermes-qwen3`)
- Исправлена сборка с современными версиями Hugo: добавлен `defaultContentLanguage = 'ru'` в hugo.toml (Hugo 0.123+ требует, чтобы defaultContentLanguage совпадал с одним из `[languages]`, иначе ошибка `config value "en" does not match any language definition`)
- Установлен локальный git identity в репозитории: Storozhenko Evgeny <kpa39l@yandex.ru>
- Подробный опыт настройки локальных aux-моделей Hermes задокументирован в [docs/local-aux-models.md](docs/local-aux-models.md)
-
-### 31 января 2026 года
-
- Установлена Hugo расширенная версия 0.155.1
- Создан новый сайт dedinit.ru
- Установлена тема PaperMod
- Настроено bundle хранение статей
- Создан пример статьи в формате bundle
- Настроена интеграция с Gitea сервером
-
-### 5 марта 2026 года
-
- Миграция репозитория на GitVerse (gitverse.ru:kpa39l/dedinit.ru)
-
-### 1 февраля 2026 года
-
- Разработано решение для деплоя сайта через SFTP
- Настроен Makefile для кроссплатформенного деплоя (Windows/Linux/macOS)
- Создан скрипт winscp_script.txt для подключения и синхронизации файлов
- Обновлены инструкции по деплою в DEPLOY_INSTRUCTIONS.md и README.md
-
-## Принятые технические решения
-
-1. **Выбор Hugo**: Выбран генератор статичных сайтов Hugo для быстродействия и гибкости
-2. **Расширенная версия Hugo**: Используется расширенная версия для поддержки SCSS
-3. **Тема PaperMod**: Легкая и адаптивная тема с поддержкой темной/светлой темы
-4. **Bundle хранение статей**: Используется формат bundle (папка с index.md) для удобного хранения статьи и связанных файлов
-5. **Хранение на GitVerse**: Контент хранится на GitVerse для полного контроля
-6. **SSH подключение**: Используется SSH для безопасного доступа к репозиторию
-7. **Структура проекта**: Правильная иерархия папок с .gitignore для исключения ненужных файлов
-
-## Запуск проекта
-
-Для генерации сайта и просмотра его в браузере используйте следующие команды:
-
- `hugo` - генерирует статический сайт в папку `public`
- `hugo server` - запускает локальный сервер для предварительного просмотра сайта в браузере (обычно доступен по адресу <http://localhost:1313>)
-
-## Деплой сайта
-
-> **ЕДИНСТВЕННЫЙ способ деплоя сайта — `make deploy`.** Не деплойте вручную
-> (rsync/ssh-exec напрямую не работают: аккаунт Jino SFTP-only).
-
-Специальные файлы:
-
- `Makefile` — команды сборки и публикации (Unix: SFTP через `tools/deploy_sftp.py`
-  на paramiko; Windows: WinSCP.com)
- `tools/deploy_sftp.py` — рекурсивный mirror `public/` → `/dedinit.ru`
-  (с удалением лишнего, как `rsync --delete`), пароль из env `SSHPASS`
- `winscp_script.txt` — скрипт для WinSCP (Windows)
- `DEPLOY_INSTRUCTIONS.md` — инструкция по деплою
-
-Для публикации сайта на хостинге:
-
-```shell
-export SSHPASS='<пароль SFTP из DEPLOY_INSTRUCTIONS.md>'
-make deploy
+```bash
+hugo                 # сборка в public/
+hugo server          # локальный сервер: http://localhost:1313
+make build           # сборка через Makefile (hugo --minify)
+make deploy          # сборка + деплой (требует SSHPASS)
 ```

-Первая сборка создаст `.venv/` (paramiko). Для получения полного списка команд:
+**ЕДИНСТВЕННЫЙ способ деплоя — `make deploy`.** Не заменять на rsync/ssh-exec:
+аккаунт хостинга SFTP-only. Подробности — в `docs/DEPLOY_INSTRUCTIONS.md`.

-```shell
-make help
+## Структура
+
+```
+dedinit.ru/
+├── content/posts/    # Статьи блога (bundle: папка с index.md + hero.svg)
+├── themes/rDedInit/  # Кастомная тема на базе PaperMod
+├── static/           # Статические ресурсы (favicon и т.д.)
+├── docs/             # ВСЯ документация проекта
+├── tools/            # Скрипты деплоя (deploy_sftp.py, winscp_script.txt)
+├── hugo.toml         # Конфигурация Hugo
+├── Makefile          # Сборка и деплой
+├── README.md         # Краткое введение (этот файл)
+└── AGENTS.md         # Правила работы для агентов
 ```

-Процесс кроссплатформенный: на Unix — SFTP (paramiko), на Windows — WinSCP.com.
-НЕ удаляйте `make deploy` и не заменяйте его на прямой rsync.
+## Документация
+
+Вся подробная документация — в каталоге [`docs/`](docs/):
+
+| Документ | О чём |
+|----------|-------|
+| [DEPLOY_INSTRUCTIONS.md](docs/DEPLOY_INSTRUCTIONS.md) | Деплой через SFTP (kpa39l.myjino.ru:2222) |
+| [ROADMAP.md](docs/ROADMAP.md) | Дорожная карта проекта |
+| [PAPERMOD_PARAMS.md](docs/PAPERMOD_PARAMS.md) | Справочник параметров темы rDedInit |
+| [QWEN.md](docs/QWEN.md) | Настройки взаимодействия и описание проекта |
+| [gitea-setup.md](docs/gitea-setup.md) | Интеграция с Gitea |
+| [Telegram_frontend.md](docs/Telegram_frontend.md) | Оформление Telegram-постов |
+| [favicon-logo-setup.md](docs/favicon-logo-setup.md) | Настройка favicon и логотипа |
+| [local-aux-models.md](docs/local-aux-models.md) | Опыт: локальные aux-модели Hermes |
+| [archive/](docs/archive/) | Архив устаревших документов |
+
+## Конвенции
+
+- Ветка `main`; источник истины — [gitverse.ru](https://gitverse.ru) (`kpa39l/dedinit.ru`), Gitea — pull-mirror.
+- Правила работы для агентов — [`AGENTS.md`](AGENTS.md).
+- Планирование изменений — OpenSpec (`openspec/`).