Configuration

Codex builds require minimal configuration beyond the standard docset.yml used by all build modes.

environment.yml

Each codex environment is defined by an environment.yml (or config.yml) file that controls the environment's identity, groups, and settings:

		environment: my-environment
site_prefix: /

title: My Documentation Hub

groups:
  - id: platform
    name: "Platform Team"
    description: "Platform services documentation."
    icon: documentation
  - id: tools
    name: "Internal Tools"
    description: "Tooling and automation documentation."
    icon: asterisk
		
	

Field	Description
`environment`	Environment identifier. Repositories opt in by setting `registry: <environment>` in their `docset.yml`.
`site_prefix`	URL prefix for the entire codex site. Typically `/`.
`title`	Display title shown on the landing page.
`groups`	Optional list of groups for organizing repositories on the landing page.

Group configuration

Field	Required	Description
`id`	Yes	Unique identifier. Used in URLs (`/g/{id}`) and referenced by docsets via `codex.group`.
`name`	Yes	Display name shown on the landing page card.
`description`	No	Short description shown on the card.
`icon`	No	Icon identifier for the group card.

Repository configuration

Each repository opts into a codex environment through its docset.yml:

		icon: asterisk
registry: my-environment

toc:
  - file: index.md

To join a group:

		icon: asterisk
registry: my-environment

codex:
  group: platform

toc:
  - file: index.md
		
	