Jak korzystać z tej dokumentacji referencyjnej
Dokumentacja języka opisuje powierzchnię autorską Aggrega — schematy YAML, wspólny słownik słów kluczowych, system szablonów Go, kontrakty dostawców, polecenia CLI, katalog błędów kompilatora oraz kompletne przykłady. Przy pierwszym zapoznawaniu się z dokumentacją należy czytać poniższe rozdziały po kolei; przy wyszukiwaniu konkretnej encji, słowa kluczowego, dostawcy, polecenia CLI lub błędu można przejść bezpośrednio do odpowiedniego podkatalogu.
Aby najpierw zainstalować plik binarny aggrega, należy wykonać kroki z sekcji Instalacja pliku binarnego; aby asystent AI zainstalował go i skonfigurował za użytkownika, należy wkleić prompt z sekcji Konfiguracja Aggrega z asystentem AI. Przed budowaniem skryptów lub katalogu na Aggrega należy przeczytać sekcję Zgodność, aby wiedzieć, co aktualizacja może zmienić, a czego nie.
Przed lekturą dokumentacji warto przyswoić model myślowy, który wprowadzają rozdziały o architekturze. Rozdział Cztery domeny i topologie zespołów wyjaśnia, jak Aggrega rozdziela kwestie Developer Intent, Platform Catalog, Platform Ops i Platform Operator na odrębne powierzchnie autorskie; rozdział Taksonomia encji wymienia encje (Aggregate, Component, Feature, Recipe, FeatureRecipe, Plugin, Manifest, Release, SchemaLibrary, MappingLibrary, WorkloadLibrary, ArtifactLibrary) i ich role w tych domenach. Każdy kolejny rozdział dokumentacji zakłada, że czytelnik zna tę strukturę.
Z dokumentacji można korzystać na dwa sposoby. Na początek należy czytać ją po kolei: zacząć od rozdziału Konwencje nazewnictwa, opisującego wzorzec nazw instancji i zasady wielkości liter, a następnie przejść przez rozdziały o encjach i słowniku, aby poznać pełny kontrakt autorski. Przy wyszukiwaniu informacji należy przejść bezpośrednio do podkatalogu odpowiadającego pytaniu — entities/ zawiera semantykę pól poszczególnych encji, vocabulary/ słowa kluczowe wspólne dla encji, templates/ powierzchnię szablonów Go dostępną dla autorów encji Recipe, providers/ kontrakty wywołań poszczególnych dostawców, plugins/ gniazda pluginów i tworzenie pluginów, schema/ JSON Schema każdego rodzaju, cli/ sposób użycia wiersza poleceń, errors/ diagnostykę, a examples/ przykładowe wzorce.