go-help/CLAUDE.md
Snider ad5e70937b feat: extract go-help from core/go pkg/help
YAML-based help catalog with topic search.
Single external dependency: gopkg.in/yaml.v3
Module: forge.lthn.ai/core/go-help

Co-Authored-By: Virgil <virgil@lethean.io>
2026-02-19 16:09:34 +00:00

613 B

CLAUDE.md

What This Is

YAML-based help catalog with topic search and rendering. Module: forge.lthn.ai/core/go-help

Commands

go test ./...          # Run all tests
go test -v -run Name   # Run single test

Architecture

  • Topic defines help entries with title, body, tags, related topics
  • Catalog loads topics from YAML files
  • Search provides fuzzy search across topics by title, tags, body

Coding Standards

  • UK English
  • go test ./... must pass before commit
  • Conventional commits: type(scope): description
  • Co-Author: Co-Authored-By: Virgil <virgil@lethean.io>