@x12i/memorix-docs 1.0.2 → 1.1.1

package/files/packs/guide/diagnose-unresolved/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/diagnose-unresolved",
+  "type": "guide",
+  "title": "Diagnose an unresolved relationship target",
+  "summary": "Distinguish intentional unresolved from broken targets.",
+  "markdownPath": "guides/diagnose-unresolved.md",
+  "files": [
+    "guides/diagnose-unresolved.md"
+  ],
+  "related": [
+    "resolved-unresolved"
+  ]
+}

package/files/packs/guide/evidence-to-decision/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/evidence-to-decision"
+type: "pack"
+title: "Move from evidence to analysis and a decision"
+summary: "Record analysis, then a distinct decision."
+---
+# Pack: Move from evidence to analysis and a decision
+
+Record analysis, then a distinct decision.
+
+Primary markdown: `guides/evidence-to-decision.md`

package/files/packs/guide/evidence-to-decision/pack.json

@@ -0,0 +1,14 @@
+{
+  "id": "guide/evidence-to-decision",
+  "type": "guide",
+  "title": "Move from evidence to analysis and a decision",
+  "summary": "Record analysis, then a distinct decision.",
+  "markdownPath": "guides/evidence-to-decision.md",
+  "files": [
+    "guides/evidence-to-decision.md"
+  ],
+  "related": [
+    "analysis-objects",
+    "decisions-content"
+  ]
+}

package/files/packs/guide/first-revision-safe-write/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/first-revision-safe-write"
+type: "pack"
+title: "Perform a first revision-safe read/write"
+summary: "Read a record, write with expected revision, verify."
+---
+# Pack: Perform a first revision-safe read/write
+
+Read a record, write with expected revision, verify.
+
+Primary markdown: `guides/first-revision-safe-write.md`

package/files/packs/guide/first-revision-safe-write/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/first-revision-safe-write",
+  "type": "guide",
+  "title": "Perform a first revision-safe read/write",
+  "summary": "Read a record, write with expected revision, verify.",
+  "markdownPath": "guides/first-revision-safe-write.md",
+  "files": [
+    "guides/first-revision-safe-write.md"
+  ],
+  "related": [
+    "record-revisions"
+  ]
+}

package/files/packs/guide/inspect-effective-metadata/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/inspect-effective-metadata"
+type: "pack"
+title: "Inspect effective metadata before read/write"
+summary: "Confirm effective definitions before mutating records."
+---
+# Pack: Inspect effective metadata before read/write
+
+Confirm effective definitions before mutating records.
+
+Primary markdown: `guides/inspect-effective-metadata.md`

package/files/packs/guide/inspect-effective-metadata/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/inspect-effective-metadata",
+  "type": "guide",
+  "title": "Inspect effective metadata before read/write",
+  "summary": "Confirm effective definitions before mutating records.",
+  "markdownPath": "guides/inspect-effective-metadata.md",
+  "files": [
+    "guides/inspect-effective-metadata.md"
+  ],
+  "related": [
+    "effective-metadata"
+  ]
+}

package/files/packs/guide/query-people-abstract/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/query-people-abstract"
+type: "pack"
+title: "Query the People abstract view"
+summary: "Read employees and contractors through People bindings."
+---
+# Pack: Query the People abstract view
+
+Read employees and contractors through People bindings.
+
+Primary markdown: `guides/query-people-abstract.md`

package/files/packs/guide/query-people-abstract/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/query-people-abstract",
+  "type": "guide",
+  "title": "Query the People abstract view",
+  "summary": "Read employees and contractors through People bindings.",
+  "markdownPath": "guides/query-people-abstract.md",
+  "files": [
+    "guides/query-people-abstract.md"
+  ],
+  "related": [
+    "people-union"
+  ]
+}

package/files/packs/guide/reload-retry-conflict/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/reload-retry-conflict"
+type: "pack"
+title: "Reload, compare, and retry after a revision conflict"
+summary: "Recover safely when a stale write is rejected."
+---
+# Pack: Reload, compare, and retry after a revision conflict
+
+Recover safely when a stale write is rejected.
+
+Primary markdown: `guides/reload-retry-conflict.md`

package/files/packs/guide/reload-retry-conflict/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/reload-retry-conflict",
+  "type": "guide",
+  "title": "Reload, compare, and retry after a revision conflict",
+  "summary": "Recover safely when a stale write is rejected.",
+  "markdownPath": "guides/reload-retry-conflict.md",
+  "files": [
+    "guides/reload-retry-conflict.md"
+  ],
+  "related": [
+    "record-revisions"
+  ]
+}

package/files/packs/guide/validate-install-pack/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "guide/validate-install-pack"
+type: "pack"
+title: "Validate and explicitly install a metadata pack"
+summary: "Validate first, then confirm installation."
+---
+# Pack: Validate and explicitly install a metadata pack
+
+Validate first, then confirm installation.
+
+Primary markdown: `guides/validate-install-pack.md`

package/files/packs/guide/validate-install-pack/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "guide/validate-install-pack",
+  "type": "guide",
+  "title": "Validate and explicitly install a metadata pack",
+  "summary": "Validate first, then confirm installation.",
+  "markdownPath": "guides/validate-install-pack.md",
+  "files": [
+    "guides/validate-install-pack.md"
+  ],
+  "related": [
+    "explicit-metadata-installation"
+  ]
+}

package/files/packs/scenario/choose-subject-view/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/choose-subject-view"
+type: "pack"
+title: "A caller needs a subject view"
+summary: "Choose raw, composition, or abstract based on fidelity needs."
+---
+# Pack: A caller needs a subject view
+
+Choose raw, composition, or abstract based on fidelity needs.
+
+Primary markdown: `scenarios/choose-subject-view.md`

package/files/packs/scenario/choose-subject-view/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/choose-subject-view",
+  "type": "scenario",
+  "title": "A caller needs a subject view",
+  "summary": "Choose raw, composition, or abstract based on fidelity needs.",
+  "markdownPath": "scenarios/choose-subject-view.md",
+  "files": [
+    "scenarios/choose-subject-view.md"
+  ],
+  "related": []
+}

package/files/packs/scenario/pack-valid-not-installed/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/pack-valid-not-installed"
+type: "pack"
+title: "A metadata pack is valid but not installed"
+summary: "Validation succeeded; runtime still on previous effective metadata."
+---
+# Pack: A metadata pack is valid but not installed
+
+Validation succeeded; runtime still on previous effective metadata.
+
+Primary markdown: `scenarios/pack-valid-not-installed.md`

package/files/packs/scenario/pack-valid-not-installed/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/pack-valid-not-installed",
+  "type": "scenario",
+  "title": "A metadata pack is valid but not installed",
+  "summary": "Validation succeeded; runtime still on previous effective metadata.",
+  "markdownPath": "scenarios/pack-valid-not-installed.md",
+  "files": [
+    "scenarios/pack-valid-not-installed.md"
+  ],
+  "related": []
+}

package/files/packs/scenario/scope-mismatch/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/scope-mismatch"
+type: "pack"
+title: "Scope does not match the intended workspace"
+summary: "Detected organization/agent scope differs from the task."
+---
+# Pack: Scope does not match the intended workspace
+
+Detected organization/agent scope differs from the task.
+
+Primary markdown: `scenarios/scope-mismatch.md`

package/files/packs/scenario/scope-mismatch/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/scope-mismatch",
+  "type": "scenario",
+  "title": "Scope does not match the intended workspace",
+  "summary": "Detected organization/agent scope differs from the task.",
+  "markdownPath": "scenarios/scope-mismatch.md",
+  "files": [
+    "scenarios/scope-mismatch.md"
+  ],
+  "related": []
+}

package/files/packs/scenario/stale-revision-conflict/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/stale-revision-conflict"
+type: "pack"
+title: "A write returns a stale-revision conflict"
+summary: "PATCH/PUT rejected because expected revision was stale."
+---
+# Pack: A write returns a stale-revision conflict
+
+PATCH/PUT rejected because expected revision was stale.
+
+Primary markdown: `scenarios/stale-revision-conflict.md`

package/files/packs/scenario/stale-revision-conflict/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/stale-revision-conflict",
+  "type": "scenario",
+  "title": "A write returns a stale-revision conflict",
+  "summary": "PATCH/PUT rejected because expected revision was stale.",
+  "markdownPath": "scenarios/stale-revision-conflict.md",
+  "files": [
+    "scenarios/stale-revision-conflict.md"
+  ],
+  "related": []
+}

package/files/packs/scenario/traversal-direction/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/traversal-direction"
+type: "pack"
+title: "Relationship traversal direction and expansion"
+summary: "Choose forward/inverse and expanded/unexpanded handling."
+---
+# Pack: Relationship traversal direction and expansion
+
+Choose forward/inverse and expanded/unexpanded handling.
+
+Primary markdown: `scenarios/traversal-direction.md`

package/files/packs/scenario/traversal-direction/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/traversal-direction",
+  "type": "scenario",
+  "title": "Relationship traversal direction and expansion",
+  "summary": "Choose forward/inverse and expanded/unexpanded handling.",
+  "markdownPath": "scenarios/traversal-direction.md",
+  "files": [
+    "scenarios/traversal-direction.md"
+  ],
+  "related": []
+}

package/files/packs/scenario/unresolved-relationship/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "scenario/unresolved-relationship"
+type: "pack"
+title: "A relationship target is unresolved"
+summary: "Traversal returns an unresolved target marker."
+---
+# Pack: A relationship target is unresolved
+
+Traversal returns an unresolved target marker.
+
+Primary markdown: `scenarios/unresolved-relationship.md`

package/files/packs/scenario/unresolved-relationship/pack.json

@@ -0,0 +1,11 @@
+{
+  "id": "scenario/unresolved-relationship",
+  "type": "scenario",
+  "title": "A relationship target is unresolved",
+  "summary": "Traversal returns an unresolved target marker.",
+  "markdownPath": "scenarios/unresolved-relationship.md",
+  "files": [
+    "scenarios/unresolved-relationship.md"
+  ],
+  "related": []
+}

package/files/packs/tutorial/analysis-decision-lab/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/analysis-decision-lab"
+type: "pack"
+title: "Move from records to analysis and a decision"
+summary: "Create analysis then a distinct decision on sample evidence."
+---
+# Pack: Move from records to analysis and a decision
+
+Create analysis then a distinct decision on sample evidence.
+
+Primary markdown: `tutorials/analysis-decision-lab.md`

package/files/packs/tutorial/analysis-decision-lab/pack.json

@@ -0,0 +1,14 @@
+{
+  "id": "tutorial/analysis-decision-lab",
+  "type": "tutorial",
+  "title": "Move from records to analysis and a decision",
+  "summary": "Create analysis then a distinct decision on sample evidence.",
+  "markdownPath": "tutorials/analysis-decision-lab.md",
+  "files": [
+    "tutorials/analysis-decision-lab.md"
+  ],
+  "related": [
+    "analysis-objects",
+    "decisions-content"
+  ]
+}

package/files/packs/tutorial/compare-views/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/compare-views"
+type: "pack"
+title: "Compare raw, composed, and abstract views"
+summary: "See fidelity differences on the same subjects."
+---
+# Pack: Compare raw, composed, and abstract views
+
+See fidelity differences on the same subjects.
+
+Primary markdown: `tutorials/compare-views.md`

package/files/packs/tutorial/compare-views/pack.json

@@ -0,0 +1,14 @@
+{
+  "id": "tutorial/compare-views",
+  "type": "tutorial",
+  "title": "Compare raw, composed, and abstract views",
+  "summary": "See fidelity differences on the same subjects.",
+  "markdownPath": "tutorials/compare-views.md",
+  "files": [
+    "tutorials/compare-views.md"
+  ],
+  "related": [
+    "composition",
+    "people-union"
+  ]
+}

package/files/packs/tutorial/conflict-lab/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/conflict-lab"
+type: "pack"
+title: "Recover from a stale revision conflict"
+summary: "Trigger and recover from a conflict using sample data."
+---
+# Pack: Recover from a stale revision conflict
+
+Trigger and recover from a conflict using sample data.
+
+Primary markdown: `tutorials/conflict-lab.md`

package/files/packs/tutorial/conflict-lab/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "tutorial/conflict-lab",
+  "type": "tutorial",
+  "title": "Recover from a stale revision conflict",
+  "summary": "Trigger and recover from a conflict using sample data.",
+  "markdownPath": "tutorials/conflict-lab.md",
+  "files": [
+    "tutorials/conflict-lab.md"
+  ],
+  "related": [
+    "record-revisions"
+  ]
+}

package/files/packs/tutorial/first-revision-safe-record/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/first-revision-safe-record"
+type: "pack"
+title: "Read and write the first revision-safe record"
+summary: "Practice expected-revision writes on sample data."
+---
+# Pack: Read and write the first revision-safe record
+
+Practice expected-revision writes on sample data.
+
+Primary markdown: `tutorials/first-revision-safe-record.md`

package/files/packs/tutorial/first-revision-safe-record/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "tutorial/first-revision-safe-record",
+  "type": "tutorial",
+  "title": "Read and write the first revision-safe record",
+  "summary": "Practice expected-revision writes on sample data.",
+  "markdownPath": "tutorials/first-revision-safe-record.md",
+  "files": [
+    "tutorials/first-revision-safe-record.md"
+  ],
+  "related": [
+    "record-revisions"
+  ]
+}

package/files/packs/tutorial/install-pack-lab/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/install-pack-lab"
+type: "pack"
+title: "Validate and explicitly install a metadata pack"
+summary: "Practice validation versus confirmation."
+---
+# Pack: Validate and explicitly install a metadata pack
+
+Practice validation versus confirmation.
+
+Primary markdown: `tutorials/install-pack-lab.md`

package/files/packs/tutorial/install-pack-lab/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "tutorial/install-pack-lab",
+  "type": "tutorial",
+  "title": "Validate and explicitly install a metadata pack",
+  "summary": "Practice validation versus confirmation.",
+  "markdownPath": "tutorials/install-pack-lab.md",
+  "files": [
+    "tutorials/install-pack-lab.md"
+  ],
+  "related": [
+    "explicit-metadata-installation"
+  ]
+}

package/files/packs/tutorial/relationships-lab/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/relationships-lab"
+type: "pack"
+title: "Define, store, and traverse relationships"
+summary: "Hands-on relationship definition and traversal."
+---
+# Pack: Define, store, and traverse relationships
+
+Hands-on relationship definition and traversal.
+
+Primary markdown: `tutorials/relationships-lab.md`

package/files/packs/tutorial/relationships-lab/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "tutorial/relationships-lab",
+  "type": "tutorial",
+  "title": "Define, store, and traverse relationships",
+  "summary": "Hands-on relationship definition and traversal.",
+  "markdownPath": "tutorials/relationships-lab.md",
+  "files": [
+    "tutorials/relationships-lab.md"
+  ],
+  "related": [
+    "traversal"
+  ]
+}

package/files/packs/tutorial/start-with-sample-data/PACK.md

@@ -0,0 +1,11 @@
+---
+id: "tutorial/start-with-sample-data"
+type: "pack"
+title: "Start Memorix with the sample dataset"
+summary: "Load the synthetic dataset and confirm scope."
+---
+# Pack: Start Memorix with the sample dataset
+
+Load the synthetic dataset and confirm scope.
+
+Primary markdown: `tutorials/start-with-sample-data.md`

package/files/packs/tutorial/start-with-sample-data/pack.json

@@ -0,0 +1,13 @@
+{
+  "id": "tutorial/start-with-sample-data",
+  "type": "tutorial",
+  "title": "Start Memorix with the sample dataset",
+  "summary": "Load the synthetic dataset and confirm scope.",
+  "markdownPath": "tutorials/start-with-sample-data.md",
+  "files": [
+    "tutorials/start-with-sample-data.md"
+  ],
+  "related": [
+    "org-agent-scope"
+  ]
+}

package/files/sample-data/memorix-synthetic-basic.md

@@ -0,0 +1,13 @@
+---
+id: "memorix-synthetic-basic"
+type: "sample-data"
+title: "memorix-synthetic-basic"
+summary: "Deterministic synthetic Memorix subjects for docs, screenshots, and tutorials."
+version: "1.0.0"
+origin: "synthetic"
+---
+# Sample data: memorix-synthetic-basic
+
+Deterministic synthetic Memorix subjects for docs, screenshots, and tutorials.
+
+Origin: synthetic

package/files/scenarios/choose-subject-view.md

@@ -0,0 +1,36 @@
+---
+id: "choose-subject-view"
+type: "scenario"
+title: "A caller needs a subject view"
+summary: "Choose raw, composition, or abstract based on fidelity needs."
+audiences: ["developers"]
+---
+# A caller needs a subject view
+
+## Situation
+
+UI or API caller needs subject data and is unsure which access method to use.
+
+## Decision
+
+Raw, composed, or abstract?
+
+## Paths
+
+### Raw
+
+**When:** Need original payload/envelope fidelity
+
+Guides: `choose-access-method`
+
+### Composition
+
+**When:** Need same-subject content instances for a UI
+
+Guides: `compose-subject-ui`
+
+### Abstract
+
+**When:** Need a projected union such as People
+
+Guides: `query-people-abstract`

package/files/scenarios/pack-valid-not-installed.md

@@ -0,0 +1,33 @@
+---
+id: "pack-valid-not-installed"
+type: "scenario"
+title: "A metadata pack is valid but not installed"
+summary: "Validation succeeded; runtime still on previous effective metadata."
+audiences: ["builders"]
+invariants: ["Intelligence proposals never auto-install"]
+---
+# A metadata pack is valid but not installed
+
+## Situation
+
+Validate passed; install not confirmed.
+
+## Decision
+
+Explicitly install or cancel?
+
+## Paths
+
+### Install
+
+**When:** Change is reviewed and approved
+
+Guides: `validate-install-pack`
+
+### Cancel
+
+**When:** Not ready to change runtime
+
+Validation alone must leave runtime unchanged.
+
+Guides: _none_

package/files/scenarios/scope-mismatch.md

@@ -0,0 +1,44 @@
+---
+id: "scope-mismatch"
+type: "scenario"
+title: "Scope does not match the intended workspace"
+summary: "Detected organization/agent scope differs from the task."
+audiences: ["builders", "developers"]
+invariants: ["Do not write while scope is wrong"]
+---
+# Scope does not match the intended workspace
+
+## Situation
+
+Studio or API session is scoped to a different org/agent than intended.
+
+## Decision
+
+Apply a different scope or stop?
+
+## Signals
+
+- Wrong org label
+- Unexpected agent inheritance set
+
+## Paths
+
+### Apply correct scope
+
+**When:** You can select the intended org/agent
+
+Isolation is restored before any mutation.
+
+Guides: `apply-scope`
+
+### Stop
+
+**When:** Correct scope is unavailable or unauthorized
+
+Escalate rather than act in the wrong workspace.
+
+Guides: _none_
+
+## Escalation
+
+Ask an operator for access to the intended workspace.