Skip to content

Commit 9fedc8b

Browse files
respencer-nclclaude
andcommitted
Save session: document metadata vs body distinction
Update CLAUDE.md with metadata placement rules learned during concepts page audit. Update NOTEBOOK.md with session history. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d6b20c1 commit 9fedc8b

2 files changed

Lines changed: 38 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,25 @@ This site migrated from Hugo to MkDocs Material. Remove any Hugo shortcodes:
220220
Always use **RIDDL** (all caps) in prose. It's an acronym. Not "Riddl" or
221221
"riddl" except in code/filenames where lowercase is conventional.
222222

223+
### Metadata vs Body Definitions
224+
225+
RIDDL has a critical distinction between **body definitions**
226+
(inside `{ }`) and **metadata** (in `with { }` after the body):
227+
228+
- **Body**: types, handlers, entities, states, functions, etc.
229+
- **Metadata**: term, option, author_ref (`by author`), briefly,
230+
described by, attachment
231+
232+
**Author definitions** (not references) only occur in Module and
233+
Domain bodies. All other definitions use `by author Name` in
234+
their `with { }` block to reference an author.
235+
236+
**Option syntax** requires `is`: `option is event-sourced`,
237+
`option is technology("Kafka")`.
238+
239+
**Term syntax**: `term SKU is { |Stock Keeping Unit... }` — not
240+
`term "SKU" is described by "..."`.
241+
223242
### RIDDL Syntax in Examples
224243

225244
Code examples must match the EBNF grammar. Common issues to avoid:
@@ -230,7 +249,8 @@ Code examples must match the EBNF grammar. Common issues to avoid:
230249

231250
2. **User terminology**: Use "User" not "Actor" (per Use Cases 2.0)
232251

233-
3. **Hyphenation**: `event-sourced` (hyphenated as compound modifier)
252+
3. **Hyphenation**: `event-sourced` (hyphenated as compound
253+
modifier)
234254

235255
4. **Version requirements**:
236256
- JDK 25 (current LTS)

NOTEBOOK.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,23 @@
22

33
## Current Status
44

5-
Documentation site is complete and deployed at https://ossum.tech. All major
6-
sections are documented with proper RIDDL syntax highlighting.
5+
Documentation site is complete and deployed at https://ossum.tech.
6+
All major sections are documented with proper RIDDL syntax
7+
highlighting.
8+
9+
**Completed (2026-02-09):**
10+
11+
- Fixed metadata vs body definition confusion across 10 files
12+
- Rewrote metadata.md, author.md, term.md, option.md to show
13+
correct `with { }` placement and syntax
14+
- Removed incorrect Contains entries (Authors, Options, Terms)
15+
from context.md, entity.md, projector.md, adaptor.md
16+
- Removed Options and Terms from domain.md Contains (kept
17+
Authors — correct per grammar)
18+
- Updated cheat-sheet.md containment table to distinguish body
19+
definitions from metadata, fixed "Lives in" entries for Term,
20+
Option, and Author
21+
- All examples now match EBNF grammar
722

823
**Completed (2026-01-29):**
924

0 commit comments

Comments
 (0)