Skip to content

Document the generated integration types and lib.caisson-core.types - #93

Merged
clhodapp merged 1 commit into
mainfrom
docs/generated-integration-types
Nov 11, 2026
Merged

clhodapp merged 1 commit into
mainfrom
docs/generated-integration-types

Conversation

@clhodapp

Copy link
Copy Markdown
Contributor

This documents the generated integration types of nix-caisson/caisson#148. Merge it after nix-caisson/caisson#148.

  • The conventions of the integration namespaces describe types.module and types.configuration, which mkIntegration builds for every integration from its name and its class. An example declares an option of listOf lib.caisson.nixos.types.module.
  • The caisson-core namespace gains a types section for the option types of the core module. caisson publishes them at lib.caisson-core.types, and the flake-parts section no longer lists them. The section gives the manifest type the fields its check reads.
  • The mkIntegration and mkAltIntegration sections list types in the namespace they build.
  • In the options reference, caisson.manifest has the type lib.caisson-core.types.manifest, and caisson.<integration>.configurations names its entry type and what its refusal says.

mdbook build passes locally.

🤖 Generated with Claude Code

Every integration namespace carries `types.module` and
`types.configuration`, which `mkIntegration` builds from the name and
the class of the integration. The option types of the core module are
documented under `lib.caisson-core.types`, where caisson publishes
them, and `caisson.<integration>.configurations` names its entry type.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@clhodapp
clhodapp force-pushed the docs/generated-integration-types branch from 3bef61f to f373d8e Compare November 11, 2026 07:04
@clhodapp
clhodapp merged commit 74da676 into main Nov 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant