@x12i/memorix-docs 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (236) hide show
  1. package/dist/generated/bundle.d.ts +4849 -3
  2. package/dist/generated/bundle.d.ts.map +1 -1
  3. package/dist/generated/bundle.js +7580 -45
  4. package/dist/generated/bundle.js.map +1 -1
  5. package/dist/index.d.ts +2 -2
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js +6 -4
  8. package/dist/index.js.map +1 -1
  9. package/files/INDEX.md +84 -0
  10. package/files/SEARCH.json +3087 -0
  11. package/files/agent-manifest.json +1785 -0
  12. package/files/apis/memorix-records/overview.md +22 -0
  13. package/files/concepts/abstracts-bindings.md +27 -0
  14. package/files/concepts/agents-inheritance.md +28 -0
  15. package/files/concepts/analysis-objects.md +26 -0
  16. package/files/concepts/composition.md +27 -0
  17. package/files/concepts/decisions-content.md +27 -0
  18. package/files/concepts/effective-metadata.md +27 -0
  19. package/files/concepts/explicit-metadata-installation.md +26 -0
  20. package/files/concepts/intelligence-proposals.md +27 -0
  21. package/files/concepts/mappings-transforms.md +26 -0
  22. package/files/concepts/object-content-category.md +26 -0
  23. package/files/concepts/org-agent-scope.md +27 -0
  24. package/files/concepts/people-union.md +27 -0
  25. package/files/concepts/raw-records.md +26 -0
  26. package/files/concepts/record-revisions.md +26 -0
  27. package/files/concepts/relationship-definitions.md +26 -0
  28. package/files/concepts/relationship-references.md +27 -0
  29. package/files/concepts/resolved-unresolved.md +27 -0
  30. package/files/concepts/sources-and-memory.md +26 -0
  31. package/files/concepts/traversal.md +27 -0
  32. package/files/diagrams/agent-inheritance.md +34 -0
  33. package/files/diagrams/intelligence-journey.md +38 -0
  34. package/files/diagrams/memorix-central-journey.md +51 -0
  35. package/files/diagrams/metadata-lifecycle.md +40 -0
  36. package/files/diagrams/people-union-diagram.md +36 -0
  37. package/files/diagrams/record-content-model.md +43 -0
  38. package/files/diagrams/relationship-traversal.md +40 -0
  39. package/files/diagrams/revision-safe-write.md +39 -0
  40. package/files/examples/analysis-decision-records.md +11 -0
  41. package/files/examples/memorix-record-envelope.md +11 -0
  42. package/files/examples/metadata-pack-install.md +11 -0
  43. package/files/examples/people-abstract-query.md +11 -0
  44. package/files/examples/raw-vs-composed.md +11 -0
  45. package/files/examples/relationship-def-and-ref.md +11 -0
  46. package/files/examples/revision-conflict-response.md +11 -0
  47. package/files/examples/revision-safe-write.md +11 -0
  48. package/files/examples/traversal-resolved-unresolved.md +11 -0
  49. package/files/glossary/abstract.md +9 -0
  50. package/files/glossary/agent.md +9 -0
  51. package/files/glossary/analysis.md +9 -0
  52. package/files/glossary/binding.md +9 -0
  53. package/files/glossary/composition.md +9 -0
  54. package/files/glossary/content-type.md +9 -0
  55. package/files/glossary/data-category.md +9 -0
  56. package/files/glossary/decision.md +9 -0
  57. package/files/glossary/effective-metadata.md +9 -0
  58. package/files/glossary/intelligence-proposal.md +9 -0
  59. package/files/glossary/mapping.md +9 -0
  60. package/files/glossary/memory.md +9 -0
  61. package/files/glossary/object-type.md +9 -0
  62. package/files/glossary/relationship-definition.md +9 -0
  63. package/files/glossary/relationship-reference.md +9 -0
  64. package/files/glossary/revision.md +9 -0
  65. package/files/glossary/scope.md +9 -0
  66. package/files/glossary/source.md +9 -0
  67. package/files/glossary/traversal.md +9 -0
  68. package/files/guides/apply-scope.md +40 -0
  69. package/files/guides/choose-access-method.md +24 -0
  70. package/files/guides/compose-subject-ui.md +24 -0
  71. package/files/guides/define-traverse-relationship.md +26 -0
  72. package/files/guides/diagnose-unresolved.md +24 -0
  73. package/files/guides/evidence-to-decision.md +25 -0
  74. package/files/guides/first-revision-safe-write.md +30 -0
  75. package/files/guides/inspect-effective-metadata.md +30 -0
  76. package/files/guides/query-people-abstract.md +25 -0
  77. package/files/guides/reload-retry-conflict.md +32 -0
  78. package/files/guides/validate-install-pack.md +32 -0
  79. package/files/indexes/books.json +95 -0
  80. package/files/indexes/books.md +17 -0
  81. package/files/indexes/concepts.json +119 -0
  82. package/files/indexes/concepts.md +21 -0
  83. package/files/indexes/diagrams.json +53 -0
  84. package/files/indexes/diagrams.md +10 -0
  85. package/files/indexes/guides.json +71 -0
  86. package/files/indexes/guides.md +13 -0
  87. package/files/indexes/scenarios.json +41 -0
  88. package/files/indexes/scenarios.md +8 -0
  89. package/files/indexes/tutorials.json +47 -0
  90. package/files/indexes/tutorials.md +9 -0
  91. package/files/indexes/use-cases.json +239 -0
  92. package/files/indexes/use-cases.md +41 -0
  93. package/files/knowledge.json +2940 -0
  94. package/files/packs/concept/abstracts-bindings/PACK.md +11 -0
  95. package/files/packs/concept/abstracts-bindings/pack.json +13 -0
  96. package/files/packs/concept/agents-inheritance/PACK.md +11 -0
  97. package/files/packs/concept/agents-inheritance/pack.json +13 -0
  98. package/files/packs/concept/analysis-objects/PACK.md +11 -0
  99. package/files/packs/concept/analysis-objects/pack.json +14 -0
  100. package/files/packs/concept/composition/PACK.md +11 -0
  101. package/files/packs/concept/composition/pack.json +13 -0
  102. package/files/packs/concept/decisions-content/PACK.md +11 -0
  103. package/files/packs/concept/decisions-content/pack.json +13 -0
  104. package/files/packs/concept/effective-metadata/PACK.md +11 -0
  105. package/files/packs/concept/effective-metadata/pack.json +13 -0
  106. package/files/packs/concept/explicit-metadata-installation/PACK.md +11 -0
  107. package/files/packs/concept/explicit-metadata-installation/pack.json +14 -0
  108. package/files/packs/concept/intelligence-proposals/PACK.md +11 -0
  109. package/files/packs/concept/intelligence-proposals/pack.json +13 -0
  110. package/files/packs/concept/mappings-transforms/PACK.md +11 -0
  111. package/files/packs/concept/mappings-transforms/pack.json +13 -0
  112. package/files/packs/concept/object-content-category/PACK.md +11 -0
  113. package/files/packs/concept/object-content-category/pack.json +14 -0
  114. package/files/packs/concept/org-agent-scope/PACK.md +11 -0
  115. package/files/packs/concept/org-agent-scope/pack.json +14 -0
  116. package/files/packs/concept/people-union/PACK.md +11 -0
  117. package/files/packs/concept/people-union/pack.json +13 -0
  118. package/files/packs/concept/raw-records/PACK.md +11 -0
  119. package/files/packs/concept/raw-records/pack.json +14 -0
  120. package/files/packs/concept/record-revisions/PACK.md +11 -0
  121. package/files/packs/concept/record-revisions/pack.json +13 -0
  122. package/files/packs/concept/relationship-definitions/PACK.md +11 -0
  123. package/files/packs/concept/relationship-definitions/pack.json +14 -0
  124. package/files/packs/concept/relationship-references/PACK.md +11 -0
  125. package/files/packs/concept/relationship-references/pack.json +13 -0
  126. package/files/packs/concept/resolved-unresolved/PACK.md +11 -0
  127. package/files/packs/concept/resolved-unresolved/pack.json +13 -0
  128. package/files/packs/concept/sources-and-memory/PACK.md +11 -0
  129. package/files/packs/concept/sources-and-memory/pack.json +13 -0
  130. package/files/packs/concept/traversal/PACK.md +11 -0
  131. package/files/packs/concept/traversal/pack.json +13 -0
  132. package/files/packs/guide/apply-scope/PACK.md +11 -0
  133. package/files/packs/guide/apply-scope/pack.json +13 -0
  134. package/files/packs/guide/choose-access-method/PACK.md +11 -0
  135. package/files/packs/guide/choose-access-method/pack.json +15 -0
  136. package/files/packs/guide/compose-subject-ui/PACK.md +11 -0
  137. package/files/packs/guide/compose-subject-ui/pack.json +13 -0
  138. package/files/packs/guide/define-traverse-relationship/PACK.md +11 -0
  139. package/files/packs/guide/define-traverse-relationship/pack.json +14 -0
  140. package/files/packs/guide/diagnose-unresolved/PACK.md +11 -0
  141. package/files/packs/guide/diagnose-unresolved/pack.json +13 -0
  142. package/files/packs/guide/evidence-to-decision/PACK.md +11 -0
  143. package/files/packs/guide/evidence-to-decision/pack.json +14 -0
  144. package/files/packs/guide/first-revision-safe-write/PACK.md +11 -0
  145. package/files/packs/guide/first-revision-safe-write/pack.json +13 -0
  146. package/files/packs/guide/inspect-effective-metadata/PACK.md +11 -0
  147. package/files/packs/guide/inspect-effective-metadata/pack.json +13 -0
  148. package/files/packs/guide/query-people-abstract/PACK.md +11 -0
  149. package/files/packs/guide/query-people-abstract/pack.json +13 -0
  150. package/files/packs/guide/reload-retry-conflict/PACK.md +11 -0
  151. package/files/packs/guide/reload-retry-conflict/pack.json +13 -0
  152. package/files/packs/guide/validate-install-pack/PACK.md +11 -0
  153. package/files/packs/guide/validate-install-pack/pack.json +13 -0
  154. package/files/packs/scenario/choose-subject-view/PACK.md +11 -0
  155. package/files/packs/scenario/choose-subject-view/pack.json +11 -0
  156. package/files/packs/scenario/pack-valid-not-installed/PACK.md +11 -0
  157. package/files/packs/scenario/pack-valid-not-installed/pack.json +11 -0
  158. package/files/packs/scenario/scope-mismatch/PACK.md +11 -0
  159. package/files/packs/scenario/scope-mismatch/pack.json +11 -0
  160. package/files/packs/scenario/stale-revision-conflict/PACK.md +11 -0
  161. package/files/packs/scenario/stale-revision-conflict/pack.json +11 -0
  162. package/files/packs/scenario/traversal-direction/PACK.md +11 -0
  163. package/files/packs/scenario/traversal-direction/pack.json +11 -0
  164. package/files/packs/scenario/unresolved-relationship/PACK.md +11 -0
  165. package/files/packs/scenario/unresolved-relationship/pack.json +11 -0
  166. package/files/packs/tutorial/analysis-decision-lab/PACK.md +11 -0
  167. package/files/packs/tutorial/analysis-decision-lab/pack.json +14 -0
  168. package/files/packs/tutorial/compare-views/PACK.md +11 -0
  169. package/files/packs/tutorial/compare-views/pack.json +14 -0
  170. package/files/packs/tutorial/conflict-lab/PACK.md +11 -0
  171. package/files/packs/tutorial/conflict-lab/pack.json +13 -0
  172. package/files/packs/tutorial/first-revision-safe-record/PACK.md +11 -0
  173. package/files/packs/tutorial/first-revision-safe-record/pack.json +13 -0
  174. package/files/packs/tutorial/install-pack-lab/PACK.md +11 -0
  175. package/files/packs/tutorial/install-pack-lab/pack.json +13 -0
  176. package/files/packs/tutorial/relationships-lab/PACK.md +11 -0
  177. package/files/packs/tutorial/relationships-lab/pack.json +13 -0
  178. package/files/packs/tutorial/start-with-sample-data/PACK.md +11 -0
  179. package/files/packs/tutorial/start-with-sample-data/pack.json +13 -0
  180. package/files/sample-data/memorix-synthetic-basic.md +13 -0
  181. package/files/scenarios/choose-subject-view.md +36 -0
  182. package/files/scenarios/pack-valid-not-installed.md +33 -0
  183. package/files/scenarios/scope-mismatch.md +44 -0
  184. package/files/scenarios/stale-revision-conflict.md +38 -0
  185. package/files/scenarios/traversal-direction.md +30 -0
  186. package/files/scenarios/unresolved-relationship.md +31 -0
  187. package/files/tutorials/analysis-decision-lab.md +18 -0
  188. package/files/tutorials/compare-views.md +22 -0
  189. package/files/tutorials/conflict-lab.md +18 -0
  190. package/files/tutorials/first-revision-safe-record.md +18 -0
  191. package/files/tutorials/install-pack-lab.md +22 -0
  192. package/files/tutorials/relationships-lab.md +18 -0
  193. package/files/tutorials/start-with-sample-data.md +18 -0
  194. package/files/ui/clients/memorix-studio.md +9 -0
  195. package/files/use-cases/abstract-people-list.md +237 -0
  196. package/files/use-cases/ai-pipeline-fail-closed.md +117 -0
  197. package/files/use-cases/author-pipeline-e2e.md +339 -0
  198. package/files/use-cases/build-callable-service.md +347 -0
  199. package/files/use-cases/builder-acceptance-ops.md +112 -0
  200. package/files/use-cases/choose-access-method.md +111 -0
  201. package/files/use-cases/client-first-read-write.md +374 -0
  202. package/files/use-cases/compose-for-ui.md +97 -0
  203. package/files/use-cases/custom-kind-descriptors.md +137 -0
  204. package/files/use-cases/data-journey-evidence.md +115 -0
  205. package/files/use-cases/discriminated-content-writes.md +152 -0
  206. package/files/use-cases/embed-studio-host.md +165 -0
  207. package/files/use-cases/four-field-links.md +246 -0
  208. package/files/use-cases/http-process-compliance.md +225 -0
  209. package/files/use-cases/install-metadata-pack.md +180 -0
  210. package/files/use-cases/intelligence-propose-install.md +163 -0
  211. package/files/use-cases/knowx-claims-review.md +396 -0
  212. package/files/use-cases/learn-record-envelope.md +233 -0
  213. package/files/use-cases/lists-cursors-pagination.md +196 -0
  214. package/files/use-cases/local-acceptance-g12ops.md +160 -0
  215. package/files/use-cases/memory-hourly-ingest.md +276 -0
  216. package/files/use-cases/metadata-before-write.md +145 -0
  217. package/files/use-cases/migrate-associated-star.md +159 -0
  218. package/files/use-cases/openapi-typed-client.md +78 -0
  219. package/files/use-cases/ops-pack-fixtures.md +168 -0
  220. package/files/use-cases/orient-platform.md +172 -0
  221. package/files/use-cases/pipeline-retry-evidence.md +121 -0
  222. package/files/use-cases/relationship-rebuild-verify.md +128 -0
  223. package/files/use-cases/revision-stale-conflicts.md +194 -0
  224. package/files/use-cases/start-from-zero.md +171 -0
  225. package/files/use-cases/studio-design-types.md +122 -0
  226. package/files/use-cases/studio-explore-subject.md +89 -0
  227. package/files/use-cases/studio-operate-pipelines.md +100 -0
  228. package/files/use-cases/studio-review-intelligence.md +74 -0
  229. package/files/use-cases/studio-scope-isolation.md +67 -0
  230. package/files/use-cases/studio-stale-conflict-ui.md +54 -0
  231. package/files/use-cases/troubleshoot-http-matrix.md +164 -0
  232. package/files/use-cases/trusted-in-process-embed.md +94 -0
  233. package/files/use-cases/workflow-sibling-api.md +212 -0
  234. package/files/visuals/revision-conflict.md +19 -0
  235. package/files/visuals/scope-apply.md +19 -0
  236. package/package.json +4 -3
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: "evidence-to-decision"
3
+ type: "guide"
4
+ title: "Move from evidence to analysis and a decision"
5
+ summary: "Record analysis, then a distinct decision."
6
+ why: "Keeping them separate preserves auditability."
7
+ audiences: ["developers", "builders"]
8
+ related: ["analysis-objects", "decisions-content"]
9
+ ---
10
+ # Move from evidence to analysis and a decision
11
+
12
+ Record analysis, then a distinct decision.
13
+
14
+ ## Why this path
15
+
16
+ Keeping them separate preserves auditability.
17
+
18
+ ## Steps
19
+
20
+ 1. **Create analysis from evidence** — Analysis object
21
+ 2. **Record decision** — Decision object
22
+
23
+ ## Verification
24
+
25
+ - Decision references analysis
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: "first-revision-safe-write"
3
+ type: "guide"
4
+ title: "Perform a first revision-safe read/write"
5
+ summary: "Read a record, write with expected revision, verify."
6
+ why: "Revision preconditions prevent lost updates."
7
+ audiences: ["developers"]
8
+ related: ["record-revisions"]
9
+ invariants: ["Never omit expected revision on conditional writes"]
10
+ ---
11
+ # Perform a first revision-safe read/write
12
+
13
+ Read a record, write with expected revision, verify.
14
+
15
+ ## Why this path
16
+
17
+ Revision preconditions prevent lost updates.
18
+
19
+ ## Invariants
20
+
21
+ - Never omit expected revision on conditional writes
22
+
23
+ ## Steps
24
+
25
+ 1. **Read current record and revision** — Revision N known
26
+ 2. **Write with expected revision N** — Success or conflict
27
+
28
+ ## Verification
29
+
30
+ - Record shows revision N+1 on success
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: "inspect-effective-metadata"
3
+ type: "guide"
4
+ title: "Inspect effective metadata before read/write"
5
+ summary: "Confirm effective definitions before mutating records."
6
+ why: "Source files alone may not match runtime."
7
+ audiences: ["developers", "builders"]
8
+ prerequisites: ["apply-scope"]
9
+ related: ["effective-metadata"]
10
+ invariants: ["Writes assume the effective model"]
11
+ ---
12
+ # Inspect effective metadata before read/write
13
+
14
+ Confirm effective definitions before mutating records.
15
+
16
+ ## Why this path
17
+
18
+ Source files alone may not match runtime.
19
+
20
+ ## Invariants
21
+
22
+ - Writes assume the effective model
23
+
24
+ ## Steps
25
+
26
+ 1. **Open effective metadata view** — Resolved definitions visible
27
+
28
+ ## Verification
29
+
30
+ - Target object/content types appear as expected
@@ -0,0 +1,25 @@
1
+ ---
2
+ id: "query-people-abstract"
3
+ type: "guide"
4
+ title: "Query the People abstract view"
5
+ summary: "Read employees and contractors through People bindings."
6
+ why: "Abstract projection avoids hand-merged lists."
7
+ audiences: ["developers", "builders"]
8
+ prerequisites: ["inspect-effective-metadata"]
9
+ related: ["people-union"]
10
+ ---
11
+ # Query the People abstract view
12
+
13
+ Read employees and contractors through People bindings.
14
+
15
+ ## Why this path
16
+
17
+ Abstract projection avoids hand-merged lists.
18
+
19
+ ## Steps
20
+
21
+ 1. **Query People abstract** — Mixed concrete types under People
22
+
23
+ ## Verification
24
+
25
+ - Bindings explain each member
@@ -0,0 +1,32 @@
1
+ ---
2
+ id: "reload-retry-conflict"
3
+ type: "guide"
4
+ title: "Reload, compare, and retry after a revision conflict"
5
+ summary: "Recover safely when a stale write is rejected."
6
+ why: "The record was not mutated; retry from current state."
7
+ audiences: ["developers"]
8
+ related: ["record-revisions"]
9
+ invariants: ["Do not force overwrite without comparing meaning"]
10
+ confirmationRequired: true
11
+ ---
12
+ # Reload, compare, and retry after a revision conflict
13
+
14
+ Recover safely when a stale write is rejected.
15
+
16
+ ## Why this path
17
+
18
+ The record was not mutated; retry from current state.
19
+
20
+ ## Invariants
21
+
22
+ - Do not force overwrite without comparing meaning
23
+
24
+ ## Steps
25
+
26
+ 1. **Reload current revision** — Fresh envelope
27
+ 2. **Compare intended change to current meaning** — Decision to reapply or escalate
28
+ 3. **Retry write with new expected revision** — Success or escalate
29
+
30
+ ## Verification
31
+
32
+ - No silent overwrite of newer fields
@@ -0,0 +1,32 @@
1
+ ---
2
+ id: "validate-install-pack"
3
+ type: "guide"
4
+ title: "Validate and explicitly install a metadata pack"
5
+ summary: "Validate first, then confirm installation."
6
+ why: "Validation alone must not change runtime."
7
+ audiences: ["builders", "developers"]
8
+ related: ["explicit-metadata-installation"]
9
+ invariants: ["Intelligence proposals never auto-install"]
10
+ confirmationRequired: true
11
+ ---
12
+ # Validate and explicitly install a metadata pack
13
+
14
+ Validate first, then confirm installation.
15
+
16
+ ## Why this path
17
+
18
+ Validation alone must not change runtime.
19
+
20
+ ## Invariants
21
+
22
+ - Intelligence proposals never auto-install
23
+
24
+ ## Steps
25
+
26
+ 1. **Validate pack** — Validation report
27
+ 2. **Confirm install** — User confirms
28
+ 3. **Install pack** — Effective metadata updates
29
+
30
+ ## Verification
31
+
32
+ - Effective metadata reflects the pack
@@ -0,0 +1,95 @@
1
+ {
2
+ "version": 1,
3
+ "items": [
4
+ {
5
+ "id": "00-platform-overview",
6
+ "title": "Platform Overview",
7
+ "summary": "Surfaces, packages, hard rules, and where to start — developers and builders twins.",
8
+ "path": "books/00-platform-overview/"
9
+ },
10
+ {
11
+ "id": "01-format-for-dummies",
12
+ "title": "Format for Dummies",
13
+ "summary": "Mental model of the record envelope — OT/CT, composition, discriminators, and what is not stored on the record.",
14
+ "path": "books/01-format-for-dummies/"
15
+ },
16
+ {
17
+ "id": "02-runtime-data-client",
18
+ "title": "Runtime Data Client",
19
+ "summary": "Connection, scope, exact reads, writes, compose, abstracts, and client anti-patterns through Memorix Service / OpenAPI.",
20
+ "path": "books/02-runtime-data-client/"
21
+ },
22
+ {
23
+ "id": "03-lists-queries-pagination",
24
+ "title": "Lists, Queries, Pagination",
25
+ "summary": "List contracts, query grammar, cursors, page size, and multi-resource listing without foot-guns.",
26
+ "path": "books/03-lists-queries-pagination/"
27
+ },
28
+ {
29
+ "id": "04-data-access-patterns",
30
+ "title": "Data Access Patterns",
31
+ "summary": "Decision matrix — best / acceptable / forbidden access methods for real client tasks.",
32
+ "path": "books/04-data-access-patterns/"
33
+ },
34
+ {
35
+ "id": "05-metadata-agents-abstracts",
36
+ "title": "Metadata, Agents, Abstracts & Mappings",
37
+ "summary": "Agents, OT/CT, virtual abstracts, mappings, install/publish — never auto-install from intelligence.",
38
+ "path": "books/05-metadata-agents-abstracts/"
39
+ },
40
+ {
41
+ "id": "06-relationships-and-memory",
42
+ "title": "Relationships & Memory",
43
+ "summary": "Exact Memory ingest and relationship engine links — never associated* payloads on records.",
44
+ "path": "books/06-relationships-and-memory/"
45
+ },
46
+ {
47
+ "id": "07-services",
48
+ "title": "Building Services",
49
+ "summary": "When to build a service, handlers, pipeline invoke, and core-service / ports-manager / api-live-view.",
50
+ "path": "books/07-services/"
51
+ },
52
+ {
53
+ "id": "08-pipelines",
54
+ "title": "Building Pipelines",
55
+ "summary": "Pipeline definition, step kinds, AI fail-closed, operations, and the complete ops tutorial.",
56
+ "path": "books/08-pipelines/"
57
+ },
58
+ {
59
+ "id": "09-workflow-and-studio",
60
+ "title": "Workflow & Studio",
61
+ "summary": "Design · Operate · Explore — scope bar ≡ headers, workflow siblings, embedding guidance. Builders primary.",
62
+ "path": "books/09-workflow-and-studio/"
63
+ },
64
+ {
65
+ "id": "10-intelligence",
66
+ "title": "Structural Intelligence",
67
+ "summary": "Profile data, proposals with evidence, human install boundary.",
68
+ "path": "books/10-intelligence/"
69
+ },
70
+ {
71
+ "id": "11-agent-packs-and-ops",
72
+ "title": "Agent Packs & Ops",
73
+ "summary": "Pack layout, harness, g12ops* acceptance, custom kinds, golden V2 validation.",
74
+ "path": "books/11-agent-packs-and-ops/"
75
+ },
76
+ {
77
+ "id": "12-knowx",
78
+ "title": "Building KnowX",
79
+ "summary": "KnowX nodes/edges as content types, review siblings, runnable fixture path (no live AI required).",
80
+ "path": "books/12-knowx/"
81
+ },
82
+ {
83
+ "id": "13-migration-troubleshooting",
84
+ "title": "Migration & Troubleshooting",
85
+ "summary": "associated* rejection, stale revisions, HTTP failure matrix, escalate packets.",
86
+ "path": "books/13-migration-troubleshooting/"
87
+ },
88
+ {
89
+ "id": "14-getting-started-and-tutorials",
90
+ "title": "Getting Started & Tutorials",
91
+ "summary": "Start here — install @x12i/memorix-docs for agents, set scope, best-practice pipeline order, and hands-on tutorials.",
92
+ "path": "books/14-getting-started-and-tutorials/"
93
+ }
94
+ ]
95
+ }
@@ -0,0 +1,17 @@
1
+ # books
2
+
3
+ - `00-platform-overview` — Platform Overview — Surfaces, packages, hard rules, and where to start — developers and builders twins.
4
+ - `01-format-for-dummies` — Format for Dummies — Mental model of the record envelope — OT/CT, composition, discriminators, and what is not stored on the record.
5
+ - `02-runtime-data-client` — Runtime Data Client — Connection, scope, exact reads, writes, compose, abstracts, and client anti-patterns through Memorix Service / OpenAPI.
6
+ - `03-lists-queries-pagination` — Lists, Queries, Pagination — List contracts, query grammar, cursors, page size, and multi-resource listing without foot-guns.
7
+ - `04-data-access-patterns` — Data Access Patterns — Decision matrix — best / acceptable / forbidden access methods for real client tasks.
8
+ - `05-metadata-agents-abstracts` — Metadata, Agents, Abstracts & Mappings — Agents, OT/CT, virtual abstracts, mappings, install/publish — never auto-install from intelligence.
9
+ - `06-relationships-and-memory` — Relationships & Memory — Exact Memory ingest and relationship engine links — never associated* payloads on records.
10
+ - `07-services` — Building Services — When to build a service, handlers, pipeline invoke, and core-service / ports-manager / api-live-view.
11
+ - `08-pipelines` — Building Pipelines — Pipeline definition, step kinds, AI fail-closed, operations, and the complete ops tutorial.
12
+ - `09-workflow-and-studio` — Workflow & Studio — Design · Operate · Explore — scope bar ≡ headers, workflow siblings, embedding guidance. Builders primary.
13
+ - `10-intelligence` — Structural Intelligence — Profile data, proposals with evidence, human install boundary.
14
+ - `11-agent-packs-and-ops` — Agent Packs & Ops — Pack layout, harness, g12ops* acceptance, custom kinds, golden V2 validation.
15
+ - `12-knowx` — Building KnowX — KnowX nodes/edges as content types, review siblings, runnable fixture path (no live AI required).
16
+ - `13-migration-troubleshooting` — Migration & Troubleshooting — associated* rejection, stale revisions, HTTP failure matrix, escalate packets.
17
+ - `14-getting-started-and-tutorials` — Getting Started & Tutorials — Start here — install @x12i/memorix-docs for agents, set scope, best-practice pipeline order, and hands-on tutorials.
@@ -0,0 +1,119 @@
1
+ {
2
+ "version": 1,
3
+ "items": [
4
+ {
5
+ "id": "org-agent-scope",
6
+ "title": "Organization and agent scope",
7
+ "summary": "Scope selects which organization and agent context reads and writes apply to.",
8
+ "path": "concepts/org-agent-scope.md"
9
+ },
10
+ {
11
+ "id": "agents-inheritance",
12
+ "title": "Agents and inheritance",
13
+ "summary": "Child agents inherit definitions; Studio shows the effective result.",
14
+ "path": "concepts/agents-inheritance.md"
15
+ },
16
+ {
17
+ "id": "sources-and-memory",
18
+ "title": "Sources and Memory",
19
+ "summary": "Sources feed Memory; Memory holds durable product records.",
20
+ "path": "concepts/sources-and-memory.md"
21
+ },
22
+ {
23
+ "id": "object-content-category",
24
+ "title": "Object type, content type, and data category",
25
+ "summary": "Identity, payload shape, and category are separate axes.",
26
+ "path": "concepts/object-content-category.md"
27
+ },
28
+ {
29
+ "id": "explicit-metadata-installation",
30
+ "title": "Explicit metadata validation and installation",
31
+ "summary": "Validation does not install; installation requires confirmation.",
32
+ "path": "concepts/explicit-metadata-installation.md"
33
+ },
34
+ {
35
+ "id": "effective-metadata",
36
+ "title": "Effective metadata",
37
+ "summary": "The resolved definitions after inheritance and installation.",
38
+ "path": "concepts/effective-metadata.md"
39
+ },
40
+ {
41
+ "id": "abstracts-bindings",
42
+ "title": "Abstracts and bindings",
43
+ "summary": "An abstract is a virtual union projected through bindings — not stored rows.",
44
+ "path": "concepts/abstracts-bindings.md"
45
+ },
46
+ {
47
+ "id": "people-union",
48
+ "title": "People union",
49
+ "summary": "People combines employees and contractors through explicit bindings.",
50
+ "path": "concepts/people-union.md"
51
+ },
52
+ {
53
+ "id": "mappings-transforms",
54
+ "title": "Mappings and transforms",
55
+ "summary": "Mappings describe how source shapes become Memory content.",
56
+ "path": "concepts/mappings-transforms.md"
57
+ },
58
+ {
59
+ "id": "raw-records",
60
+ "title": "Raw records",
61
+ "summary": "Raw retains the original payload beside envelope metadata.",
62
+ "path": "concepts/raw-records.md"
63
+ },
64
+ {
65
+ "id": "composition",
66
+ "title": "Same-subject composition",
67
+ "summary": "Multiple content instances can belong to one subject when composition is explicit.",
68
+ "path": "concepts/composition.md"
69
+ },
70
+ {
71
+ "id": "relationship-definitions",
72
+ "title": "Relationship definitions",
73
+ "summary": "A relationship definition is metadata describing allowed links — not a stored edge on a record.",
74
+ "path": "concepts/relationship-definitions.md"
75
+ },
76
+ {
77
+ "id": "relationship-references",
78
+ "title": "Stored relationship references",
79
+ "summary": "Records store relationship references that point at targets under a definition.",
80
+ "path": "concepts/relationship-references.md"
81
+ },
82
+ {
83
+ "id": "traversal",
84
+ "title": "Forward and inverse traversal",
85
+ "summary": "Traversal follows definitions forward or inverse, optionally expanding targets.",
86
+ "path": "concepts/traversal.md"
87
+ },
88
+ {
89
+ "id": "resolved-unresolved",
90
+ "title": "Resolved and unresolved relationships",
91
+ "summary": "Unresolved targets are retained and shown — not silently dropped.",
92
+ "path": "concepts/resolved-unresolved.md"
93
+ },
94
+ {
95
+ "id": "record-revisions",
96
+ "title": "Record revisions and stale-write conflicts",
97
+ "summary": "Writes carry an expected revision; stale writers cannot overwrite newer data.",
98
+ "path": "concepts/record-revisions.md"
99
+ },
100
+ {
101
+ "id": "analysis-objects",
102
+ "title": "Analysis objects",
103
+ "summary": "Analysis captures evaluated evidence distinct from operational decisions.",
104
+ "path": "concepts/analysis-objects.md"
105
+ },
106
+ {
107
+ "id": "decisions-content",
108
+ "title": "Decisions",
109
+ "summary": "Decisions record chosen actions distinct from analysis content.",
110
+ "path": "concepts/decisions-content.md"
111
+ },
112
+ {
113
+ "id": "intelligence-proposals",
114
+ "title": "Intelligence proposals",
115
+ "summary": "Intelligence may propose metadata or actions but never auto-installs them.",
116
+ "path": "concepts/intelligence-proposals.md"
117
+ }
118
+ ]
119
+ }
@@ -0,0 +1,21 @@
1
+ # concepts
2
+
3
+ - `org-agent-scope` — Organization and agent scope — Scope selects which organization and agent context reads and writes apply to.
4
+ - `agents-inheritance` — Agents and inheritance — Child agents inherit definitions; Studio shows the effective result.
5
+ - `sources-and-memory` — Sources and Memory — Sources feed Memory; Memory holds durable product records.
6
+ - `object-content-category` — Object type, content type, and data category — Identity, payload shape, and category are separate axes.
7
+ - `explicit-metadata-installation` — Explicit metadata validation and installation — Validation does not install; installation requires confirmation.
8
+ - `effective-metadata` — Effective metadata — The resolved definitions after inheritance and installation.
9
+ - `abstracts-bindings` — Abstracts and bindings — An abstract is a virtual union projected through bindings — not stored rows.
10
+ - `people-union` — People union — People combines employees and contractors through explicit bindings.
11
+ - `mappings-transforms` — Mappings and transforms — Mappings describe how source shapes become Memory content.
12
+ - `raw-records` — Raw records — Raw retains the original payload beside envelope metadata.
13
+ - `composition` — Same-subject composition — Multiple content instances can belong to one subject when composition is explicit.
14
+ - `relationship-definitions` — Relationship definitions — A relationship definition is metadata describing allowed links — not a stored edge on a record.
15
+ - `relationship-references` — Stored relationship references — Records store relationship references that point at targets under a definition.
16
+ - `traversal` — Forward and inverse traversal — Traversal follows definitions forward or inverse, optionally expanding targets.
17
+ - `resolved-unresolved` — Resolved and unresolved relationships — Unresolved targets are retained and shown — not silently dropped.
18
+ - `record-revisions` — Record revisions and stale-write conflicts — Writes carry an expected revision; stale writers cannot overwrite newer data.
19
+ - `analysis-objects` — Analysis objects — Analysis captures evaluated evidence distinct from operational decisions.
20
+ - `decisions-content` — Decisions — Decisions record chosen actions distinct from analysis content.
21
+ - `intelligence-proposals` — Intelligence proposals — Intelligence may propose metadata or actions but never auto-installs them.
@@ -0,0 +1,53 @@
1
+ {
2
+ "version": 1,
3
+ "items": [
4
+ {
5
+ "id": "memorix-central-journey",
6
+ "title": "Memorix central product journey",
7
+ "summary": "Conceptual path from scope through metadata, records, relationships, analysis, and decisions.",
8
+ "path": "diagrams/memorix-central-journey.md"
9
+ },
10
+ {
11
+ "id": "agent-inheritance",
12
+ "title": "Agent inheritance",
13
+ "summary": "Parent and child agents resolve into effective definitions.",
14
+ "path": "diagrams/agent-inheritance.md"
15
+ },
16
+ {
17
+ "id": "metadata-lifecycle",
18
+ "title": "Metadata lifecycle",
19
+ "summary": "Pack → validate → explicit install → effective resolution → runtime; proposals stay off the auto path.",
20
+ "path": "diagrams/metadata-lifecycle.md"
21
+ },
22
+ {
23
+ "id": "record-content-model",
24
+ "title": "Record and content model",
25
+ "summary": "Record identity relates to object type, content type, category, raw, snapshots, and composition.",
26
+ "path": "diagrams/record-content-model.md"
27
+ },
28
+ {
29
+ "id": "people-union-diagram",
30
+ "title": "People abstract union",
31
+ "summary": "Employees and contractors bind into the People abstract projection.",
32
+ "path": "diagrams/people-union-diagram.md"
33
+ },
34
+ {
35
+ "id": "relationship-traversal",
36
+ "title": "Relationship definition to traversal",
37
+ "summary": "Definition versus stored reference; forward/inverse; resolved versus unresolved.",
38
+ "path": "diagrams/relationship-traversal.md"
39
+ },
40
+ {
41
+ "id": "revision-safe-write",
42
+ "title": "Revision-safe write flow",
43
+ "summary": "Load, write with expected revision, success or conflict with reload/retry.",
44
+ "path": "diagrams/revision-safe-write.md"
45
+ },
46
+ {
47
+ "id": "intelligence-journey",
48
+ "title": "Intelligence journey",
49
+ "summary": "Evidence can yield analysis, decision, and proposals that still require explicit install.",
50
+ "path": "diagrams/intelligence-journey.md"
51
+ }
52
+ ]
53
+ }
@@ -0,0 +1,10 @@
1
+ # diagrams
2
+
3
+ - `memorix-central-journey` — Memorix central product journey — Conceptual path from scope through metadata, records, relationships, analysis, and decisions.
4
+ - `agent-inheritance` — Agent inheritance — Parent and child agents resolve into effective definitions.
5
+ - `metadata-lifecycle` — Metadata lifecycle — Pack → validate → explicit install → effective resolution → runtime; proposals stay off the auto path.
6
+ - `record-content-model` — Record and content model — Record identity relates to object type, content type, category, raw, snapshots, and composition.
7
+ - `people-union-diagram` — People abstract union — Employees and contractors bind into the People abstract projection.
8
+ - `relationship-traversal` — Relationship definition to traversal — Definition versus stored reference; forward/inverse; resolved versus unresolved.
9
+ - `revision-safe-write` — Revision-safe write flow — Load, write with expected revision, success or conflict with reload/retry.
10
+ - `intelligence-journey` — Intelligence journey — Evidence can yield analysis, decision, and proposals that still require explicit install.
@@ -0,0 +1,71 @@
1
+ {
2
+ "version": 1,
3
+ "items": [
4
+ {
5
+ "id": "apply-scope",
6
+ "title": "Select and apply organization/agent scope",
7
+ "summary": "Set the workspace scope before reading or writing.",
8
+ "path": "guides/apply-scope.md"
9
+ },
10
+ {
11
+ "id": "inspect-effective-metadata",
12
+ "title": "Inspect effective metadata before read/write",
13
+ "summary": "Confirm effective definitions before mutating records.",
14
+ "path": "guides/inspect-effective-metadata.md"
15
+ },
16
+ {
17
+ "id": "choose-access-method",
18
+ "title": "Choose raw, composed, or abstract access",
19
+ "summary": "Pick the fidelity that matches the caller goal.",
20
+ "path": "guides/choose-access-method.md"
21
+ },
22
+ {
23
+ "id": "first-revision-safe-write",
24
+ "title": "Perform a first revision-safe read/write",
25
+ "summary": "Read a record, write with expected revision, verify.",
26
+ "path": "guides/first-revision-safe-write.md"
27
+ },
28
+ {
29
+ "id": "reload-retry-conflict",
30
+ "title": "Reload, compare, and retry after a revision conflict",
31
+ "summary": "Recover safely when a stale write is rejected.",
32
+ "path": "guides/reload-retry-conflict.md"
33
+ },
34
+ {
35
+ "id": "validate-install-pack",
36
+ "title": "Validate and explicitly install a metadata pack",
37
+ "summary": "Validate first, then confirm installation.",
38
+ "path": "guides/validate-install-pack.md"
39
+ },
40
+ {
41
+ "id": "define-traverse-relationship",
42
+ "title": "Define and traverse a relationship",
43
+ "summary": "Author a definition, store a reference, traverse forward/inverse.",
44
+ "path": "guides/define-traverse-relationship.md"
45
+ },
46
+ {
47
+ "id": "diagnose-unresolved",
48
+ "title": "Diagnose an unresolved relationship target",
49
+ "summary": "Distinguish intentional unresolved from broken targets.",
50
+ "path": "guides/diagnose-unresolved.md"
51
+ },
52
+ {
53
+ "id": "compose-subject-ui",
54
+ "title": "Compose same-subject content for a UI",
55
+ "summary": "Load composition for a subject the UI will render.",
56
+ "path": "guides/compose-subject-ui.md"
57
+ },
58
+ {
59
+ "id": "query-people-abstract",
60
+ "title": "Query the People abstract view",
61
+ "summary": "Read employees and contractors through People bindings.",
62
+ "path": "guides/query-people-abstract.md"
63
+ },
64
+ {
65
+ "id": "evidence-to-decision",
66
+ "title": "Move from evidence to analysis and a decision",
67
+ "summary": "Record analysis, then a distinct decision.",
68
+ "path": "guides/evidence-to-decision.md"
69
+ }
70
+ ]
71
+ }
@@ -0,0 +1,13 @@
1
+ # guides
2
+
3
+ - `apply-scope` — Select and apply organization/agent scope — Set the workspace scope before reading or writing.
4
+ - `inspect-effective-metadata` — Inspect effective metadata before read/write — Confirm effective definitions before mutating records.
5
+ - `choose-access-method` — Choose raw, composed, or abstract access — Pick the fidelity that matches the caller goal.
6
+ - `first-revision-safe-write` — Perform a first revision-safe read/write — Read a record, write with expected revision, verify.
7
+ - `reload-retry-conflict` — Reload, compare, and retry after a revision conflict — Recover safely when a stale write is rejected.
8
+ - `validate-install-pack` — Validate and explicitly install a metadata pack — Validate first, then confirm installation.
9
+ - `define-traverse-relationship` — Define and traverse a relationship — Author a definition, store a reference, traverse forward/inverse.
10
+ - `diagnose-unresolved` — Diagnose an unresolved relationship target — Distinguish intentional unresolved from broken targets.
11
+ - `compose-subject-ui` — Compose same-subject content for a UI — Load composition for a subject the UI will render.
12
+ - `query-people-abstract` — Query the People abstract view — Read employees and contractors through People bindings.
13
+ - `evidence-to-decision` — Move from evidence to analysis and a decision — Record analysis, then a distinct decision.
@@ -0,0 +1,41 @@
1
+ {
2
+ "version": 1,
3
+ "items": [
4
+ {
5
+ "id": "scope-mismatch",
6
+ "title": "Scope does not match the intended workspace",
7
+ "summary": "Detected organization/agent scope differs from the task.",
8
+ "path": "scenarios/scope-mismatch.md"
9
+ },
10
+ {
11
+ "id": "stale-revision-conflict",
12
+ "title": "A write returns a stale-revision conflict",
13
+ "summary": "PATCH/PUT rejected because expected revision was stale.",
14
+ "path": "scenarios/stale-revision-conflict.md"
15
+ },
16
+ {
17
+ "id": "unresolved-relationship",
18
+ "title": "A relationship target is unresolved",
19
+ "summary": "Traversal returns an unresolved target marker.",
20
+ "path": "scenarios/unresolved-relationship.md"
21
+ },
22
+ {
23
+ "id": "pack-valid-not-installed",
24
+ "title": "A metadata pack is valid but not installed",
25
+ "summary": "Validation succeeded; runtime still on previous effective metadata.",
26
+ "path": "scenarios/pack-valid-not-installed.md"
27
+ },
28
+ {
29
+ "id": "choose-subject-view",
30
+ "title": "A caller needs a subject view",
31
+ "summary": "Choose raw, composition, or abstract based on fidelity needs.",
32
+ "path": "scenarios/choose-subject-view.md"
33
+ },
34
+ {
35
+ "id": "traversal-direction",
36
+ "title": "Relationship traversal direction and expansion",
37
+ "summary": "Choose forward/inverse and expanded/unexpanded handling.",
38
+ "path": "scenarios/traversal-direction.md"
39
+ }
40
+ ]
41
+ }
@@ -0,0 +1,8 @@
1
+ # scenarios
2
+
3
+ - `scope-mismatch` — Scope does not match the intended workspace — Detected organization/agent scope differs from the task.
4
+ - `stale-revision-conflict` — A write returns a stale-revision conflict — PATCH/PUT rejected because expected revision was stale.
5
+ - `unresolved-relationship` — A relationship target is unresolved — Traversal returns an unresolved target marker.
6
+ - `pack-valid-not-installed` — A metadata pack is valid but not installed — Validation succeeded; runtime still on previous effective metadata.
7
+ - `choose-subject-view` — A caller needs a subject view — Choose raw, composition, or abstract based on fidelity needs.
8
+ - `traversal-direction` — Relationship traversal direction and expansion — Choose forward/inverse and expanded/unexpanded handling.