Skip to content

Provider Reference Overview

The reference documentation mirrors the experience you get on the official Terraform registry: every provider is grouped by API version, each resource shows the required and optional arguments, and you can pivot between YAML and HCL snippets via tabs.

Info

These pages are generated from the API definitions in examples/api-definitions/apis. Edit the YAML files there when you need to tweak a description, add a new field, or contribute a fresh example.

Updating the generated pages

Run the doc generator any time an API definition changes:

make docs-reference

The command reads every resources.yaml file, loads the accompanying resource configuration (including the new documentation blocks), and writes Markdown files to docs/reference/providers. The MkDocs configuration then renders those files as part of the static site.

Authoring tips

  • Keep YAML and HCL examples semantically equivalent so readers can copy either without surprises.
  • Focus descriptions on how babyctl users interact with the resource instead of restating Terraform documentation word-for-word.
  • Required and optional arguments live under the same documentation.arguments array—set required: true to have docgen automatically place the field in the correct table.