- Get Started

LORE - Documentation Agent

LORE is the technical writer. It activates after every successful merge and never interrupts active development. LORE generates Architecture Decision Records, updates CHANGELOG.md, and maintains project history. Disabled by default - enable in registry.json.

Trigger

LORE is triggered by the ticket_merged event emitted by VESSEL. This event contains the ticket ID, PR number, and repository. LORE never runs during active development - only post-merge.

LORE is triggered by the ticket_merged event emitted by VESSEL:

Artifacts Produced

ArtifactLocationDescription
ADRdocs/adr/NNNN-title.mdArchitecture Decision Record for significant changes
CHANGELOG.mdRepository rootUser-visible changes with PR references
README updatesAs neededPublic API changes, new configuration options
Workflow docsdocs/workflows/Updated process documentation

ADR Template

LORE generates Architecture Decision Records (ADRs) in docs/adr/ with YAML frontmatter and markdown content. Each ADR documents the context, decision, consequences, and alternatives for significant changes to the system.

CHANGELOG.md Format

LORE maintains a CHANGELOG.md at the repository root using the Keep a Changelog format, with sections for Added, Changed, Fixed, and other change types grouped by release.

Configuration

Configure LORE in registry.json under the agents section:

Enable LORE

Set "lore": { "active": true } in registry.json. LORE is lightweight and runs on claude-haiku, making it cost-effective.

Harness Integration

LORE uses the following harness commands:

Direct commit to main

LORE commits documentation directly to the default branch via GitHub MCP. It does not open a separate PR unless the registry policy is configured to require one.

Read-Only Access

LORE has read-only access to application code. It cannot modify source files, only documentation files. This prevents accidental code changes by the documentation agent.