Commit d0806bd
committed
docs(OGAR): consumer best-practices guide + classid-is-address precision
Two coupled sharpenings of the consumer-side doctrine, born from cross-
session corroboration on the GUID layout question:
1) New OGAR-CONSUMER-BEST-PRACTICES.md — the muscle-memory guide.
Pattern-centric, example-heavy. Drilled with worked classid values
across every consumer (medcare 0x0005_0901, woa 0x0003_0103, smb
0x0004_0204, odoo 0x0002_0103, openproject 0x0001_0102, redmine
0x0007_0102, the 5-way BILLABLE_WORK_ENTRY convergence pin):
§0 the one-line invariant + three drilled corollaries
§1 address anatomy with concrete hi/lo examples + APP allocation
table + domain byte table
§2 the four canonical patterns:
Pattern 1 — pull classid (Port::class_id)
Pattern 2 — compose render classid (APP_PREFIX | concept)
Pattern 3 — authorize by classid (interim until keystone)
Pattern 4 — distill/migrate from legacy bridge (4a one-line
import repoint; 4b full structural drop)
Each pattern shown with ✅ canonical + ❌ anti shapes.
§3 anti-pattern catalogue paired with right-shape references
§4 worked migration narrative — Medcare patient end-to-end
§5 activation triggers + agents that load Tier-1
§6 cross-refs (incl. lance-graph #591 parallel-session sibling)
2) SURREAL-AST-TRAP-PREFLIGHT.md §0 — sharpens the spellbook with the
precision from lance-graph #591: "the classid is pure address; the
magic is what it resolves to." Explains why the trap is structurally
impossible to fix from inside DDL — SurrealQL has the address but
not the Core types behavior resolves to, so encoding lifecycle in
DEFINE EVENT is putting the value into the key. Cross-link to best-
practices guide added to §Cross-refs.
3) CLAUDE.md — registered best-practices guide as doc-family #8; added
matching non-negotiable ("Consumer call sites: classid is address,
magic is at the resolution target") under the existing SurrealQL
non-negotiable.
4) APP-CLASS-CODEBOOK-LAYOUT.md — top-of-doc cross-ref to the new
muscle-memory guide; reinforces hi-u16 = render magic ≠ class magic
distinction.
Companions to lance-graph #591 (parallel session's
`.claude/knowledge/ogar-consumer-preflight.md` + ISS-CONTRACT-APP-
PREFIX-MIRROR Core-gap entry) — same spellbook pattern, cast in two
domains. Two independent sessions converging on the address-vs-magic
precision is the muscle the two docs together drill across every
future consumer-side session.
Doc-only PR; no code touched.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EYvNjD8M8LMNYbRy3gq2FP1 parent 273fa78 commit d0806bd
4 files changed
Lines changed: 458 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
189 | 189 | | |
190 | 190 | | |
191 | 191 | | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
192 | 201 | | |
193 | 202 | | |
194 | 203 | | |
| |||
207 | 216 | | |
208 | 217 | | |
209 | 218 | | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
210 | 228 | | |
211 | 229 | | |
212 | 230 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
12 | 19 | | |
13 | 20 | | |
14 | 21 | | |
| |||
0 commit comments