API Go — обзор
Справочник собирается автоматически из doc-комментариев Go-модуля
go.dagstack.dev/config.
:::info Первоисточник — pkg.go.dev Канонический godoc для Go-потребителей — pkg.go.dev/go.dagstack.dev/config. Markdown-копия на этом сайте — второстепенная, нужна для единого поиска по docs + для индексации LLM-агентами через context7. Источник копии — gomarkdoc. :::
:::info Генерация отложена
В первой версии страницы ещё не сгенерированы. Запуск — make api-go
(добавится после интеграции gomarkdoc-pipeline). Содержимое пополнится
в следующих коммитах, после стабилизации реализации.
:::
Состав справочника (план)
| Модуль | Что содержит |
|---|---|
go.dagstack.dev/config | Публичный верхний уровень — Config, Load, LoadFrom, методы доступа, ошибки. |
go.dagstack.dev/config — sources | интерфейс Source, YamlFileSource, JsonFileSource, DictSource. |
go.dagstack.dev/config — errors | Error, ErrorReason. |
Как сгенерировать локально
cd config-go
git submodule update --init
go doc ./... # стандартный godoc в терминале
go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
gomarkdoc -o docs/api.md ./... # markdown-копия
Пока справочник не сгенерирован
go doc go.dagstack.dev/configвыводит API в терминале.- Публичный
godocна pkg.go.dev работает после публикации Go-модуля. - Страницы руководств: Объявить секцию, Тестирование.
- Спецификация: ADR-0001.