Skip to content

Commit 6577156

Browse files
vojtabiberleclaude
andcommitted
DMD-920 - Add package documentation for twinformat
Documents the snake_case JSON naming convention required by the Twin Format specification and explains why the tagliatelle linter is disabled. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a9ce24b commit 6577156

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

  • internal/pkg/llm/twinformat

internal/pkg/llm/twinformat/doc.go

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Package twinformat implements the Twin Format specification for LLM data export.
2+
//
3+
// # JSON Output Format
4+
//
5+
// All JSON output from this package uses snake_case field names (e.g., "primary_key",
6+
// "consumed_by", "component_id") as required by the Twin Format specification for
7+
// LLM compatibility. This intentionally differs from Go's conventional camelCase.
8+
//
9+
// The tagliatelle linter is disabled at the package level in types.go for this reason.
10+
//
11+
// # Output Structure
12+
//
13+
// The export produces the following structure:
14+
// - tables/*.json - Table definitions with lineage dependencies
15+
// - transformations/*.json - Transformation configs with code blocks
16+
// - buckets/index.json - Bucket index with statistics
17+
// - lineage/graph.jsonl - Lineage edges in JSONL format
18+
// - manifest-extended.json - Project metadata and statistics
19+
package twinformat

0 commit comments

Comments
 (0)