Как пользоваться этим справочником
Справочник по языку описывает поверхность написания Aggrega: схемы YAML, общий словарь ключевых слов, систему шаблонов Go, контракты провайдеров, команды CLI, каталог ошибок компилятора и сквозные разобранные примеры. При первом знакомстве читайте главы ниже по порядку, а при поиске конкретной сущности, ключевого слова, провайдера, команды CLI или ошибки переходите сразу в нужный подкаталог.
Чтобы сначала установить исполняемый файл aggrega, следуйте разделу Установка исполняемого файла; чтобы AI-ассистент установил и настроил его за вас, вставьте промпт из раздела Настройка Aggrega с помощью AI-ассистента. Прежде чем строить скрипты или каталог на основе Aggrega, прочитайте раздел Совместимость, чтобы знать, что обновление может изменить, а что нет.
Прежде чем читать справочник, освойте ментальную модель, которую задают главы об архитектуре. Глава Четыре домена и топологии команд объясняет, как Aggrega разделяет задачи Developer Intent, Platform Catalog, Platform Ops и Platform Operator на отдельные поверхности написания; глава Таксономия сущностей называет сущности (Aggregate, Component, Feature, Recipe, FeatureRecipe, Plugin, Manifest, Release, SchemaLibrary, MappingLibrary, WorkloadLibrary, ArtifactLibrary) и их роли в этих доменах. Каждая следующая глава справочника предполагает, что читатель знаком с этой структурой.
Пользоваться справочником можно двумя способами. Для знакомства читайте последовательно: начните с главы Соглашения об именовании, где описаны шаблон имён экземпляров и правила регистра, затем пройдите главы о сущностях и словаре, чтобы составить полный контракт написания. Для поиска переходите сразу в подкаталог, соответствующий вопросу: entities/ — семантика полей каждой сущности, vocabulary/ — ключевые слова, общие для разных сущностей, templates/ — поверхность шаблонов Go, доступная авторам сущностей Recipe, providers/ — контракты диспетчеризации каждого провайдера, plugins/ — сокеты плагинов и написание плагинов, schema/ — JSON Schema каждого вида, cli/ — использование командной строки, errors/ — диагностика, examples/ — разобранные шаблоны.