Building/.template/development/docs

Разработка шаблона Scientia

Скрытая документация для сопровождающих Typst-библиотеки. Инструкции авторов находятся в публичном каталоге docs/.

Текущее устройство

Автор работает с единственным main.typ, каталогами chapters/, assets/ и видимой документацией docs/. Внутренняя библиотека, профили организаций, тесты и архитектурные решения находятся в .template/.

Режим final, draft или clean-copy выбирается переменной внутри main.typ. Компилируемые публичные примеры четырёх видов документов и элементов оформления одновременно являются источниками для задачи выбора типа документа.

Обычная сборка использует векторные заглушки. Готовая папка .private подключается одним literal-переключателем в main.typ; отдельного ZIP installer и отдельной build task нет.

Команды сопровождающего

# Пользовательский документ
typst compile --root . main.typ document.pdf

# Полная регрессия
python .template/development/tests/run-tests.py

Навигация

Документ	Назначение
PLAN.md	Завершённые фазы редизайна и проверки
ARCHITECTURE.md	Структура, компоненты, data flow и режимы отказа
ADR-0001	Typst 0.15.1 как baseline
ADR-0002	Границы данных и ресурсов
ADR-0003	Детерминированная модель выполнения
ADR-0004	Ошибки и media fallback
ADR-0005	Направление зависимостей
ADR-0006	Визуальная регрессия
ADR-0007, устарел	Историческое решение о трёх entrypoints
ADR-0008	Версионируемая рабочая область VS Code
ADR-0009	Один main.typ, публичные примеры и приватная сборка
ADR-0010	Папка .private, справочник сотрудников и частичные подписи
Рабочее пространство автора	Минимальный корень и один входной файл
Публичные примеры	Четыре вида документов и каталог оформления
Публичная документация	Видимый docs/ для авторов
Рабочая область VS Code	Расширения, задачи и настройки
Приватные ресурсы	Справочник сотрудников, .private/settings.typ, offsets и placeholders
Публичный фасад	Стабильный Typst API
Документ	Профили и режимы выпуска
Организация	Реквизиты и ресурсы компании
Стороны	Адресаты, подписанты и стороны
Приложения	Приложения разных видов документов
Сборка	Application orchestration
Ресурсы компаний	Загрузка публичных профилей и overrides
Основа вёрстки	Tokens и media policy
Отчёт	Renderer отчёта
Письмо	Renderer письма
ТКП	Renderer предложения
Договор	Renderer договора
Компоненты	Таблицы, формулы и подписи
Ссылки	Перекрёстные ссылки и библиография
Нумерация	Стратегии нумерации
Тестирование	Static, compile, semantic и visual suites

Статус

Редизайн принят. Корневой и публичные примеры компилируются на Typst 0.15.1; полная тестовая матрица является release gate.