tenseleyflow/documentlanguagemodel / f5fb3f3

Browse files

docs(format): note .dlm file vs .dlm/ directory namespace (audit-09 m4)

Authored by espadonne
SHA
f5fb3f3fbc7f8caabf04f3b14fcee37c8aeb1241
Parents
a6b0754
Tree
c76b42a

1 changed file

StatusFile+-
M docs/format/dlm-ignore.md 16 0
docs/format/dlm-ignore.mdmodified
@@ -7,6 +7,22 @@ can have either, both, or neither.
77
 Use `.dlm/ignore` when you want drive-by exclusions without writing
88
 YAML. A three-line file is legal and common.
99
 
10
+!!! info "`.dlm` (file) vs `.dlm/` (directory) — two different things"
11
+    Both `.dlm` shapes live in this project and it's worth naming the
12
+    distinction once:
13
+
14
+    - `mydoc.dlm` — **a file** with a `.dlm` extension. The document
15
+      itself, with YAML frontmatter + markdown body. Plural: users own
16
+      many `mydoc.dlm` files, one per trainable corpus.
17
+    - `.dlm/` — **a directory** named literally `.dlm`. Lives inside a
18
+      codebase or data tree and holds `training.yaml` + `ignore` +
19
+      (when auto-scaffolded by `dlm train <dir>`) a `corpus.dlm` file.
20
+
21
+    The two share a name but not a namespace. When `dlm train <dir>`
22
+    auto-scaffolds, it creates a `.dlm/` directory inside `<dir>` and
23
+    places `corpus.dlm` inside it — so a single tree can end up with
24
+    `<dir>/.dlm/corpus.dlm`.
25
+
1026
 ## Example
1127
 
1228
 ```