Step 5 — Go deeper (when you need it)

Use this page as a map, not a checklist. Open links only when the topic applies to you.

Repository and layout

  • README — module catalog, prerequisites, Makefile, CI, registry authentication for local runs.
  • Architecture — StackGen module layers (foundation → integrations → agents → workflows); many bundles are AIOS-oriented for faster delivery.
  • examples/complete/ — large runnable composition; good reference, not the smallest first read.

Continuous integration

  • .github/workflows/ci.yml — OpenTofu tofu fmt / tofu validate, OPA; HashiCorp Terraform is interchangeable locally via make TF=terraform.

This documentation site (GitHub Pages)

  • Source: /docs on your default branch (_config.yml).
  • Forks / renames: update url, baseurl, and repository in _config.yml so links and assets resolve (see Home — Enable this site for the Pages settings path).

StackGen Terraform provider

  • Source & schema: appcd-dev/terraform-provider-stackgen — docs/index.md lists every sg_* resource and data source; AGENTS.md documents sg struct tags and provider architecture.
  • Rendered docs: GitHub Pages reference (when published).
  • Automation / LLMs: after tofu init, tofu providers schema -json exports descriptions; use the provider_schemas key that matches your root required_providers.sg.source (typically releases.stackgen.com/stackgen/stackgen).

Policies (Rego)

  • Policies live under modules/*/policies and modules/aios-policies/policies/.
  • make opa-check validates each file in isolation (how sg_policy uses them), not as one merged bundle.
  • For sample evaluation payloads, the OPA Rego Playground, and links to the Rego language docs, see Writing Rego policies.

Previous: Step 4 — Use a module
Next: Step 6 — Author a package
Back: Onboarding hub