@unrdf/diataxis-kit 26.4.2

package/test/fixtures/scaffold-det2/tutorials/tutorial-test-tutorial.md

@@ -0,0 +1,37 @@
+---
+title: "Test Tutorial"
+type: "tutorial"
+packageName: "test-deterministic"
+version: "1.0.0"
+generatedAt: "2000-01-01T00:00:00.000Z"
+confidenceScore: 0.9
+proof: "fa5ec3edd8fd24ada2fbe509ea3369703fea30ef1c5d0707430893d876099862"
+---
+
+## Overview
+
+Test
+
+## Prerequisites
+
+- None
+
+## Steps
+
+1. Step 1
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- test.md
+
+```json
+{
+  "fingerprintInput": "test.md|Test Tutorial|0.9",
+  "hash": "fa5ec3edd8fd24ada2fbe509ea3369703fea30ef1c5d0707430893d876099862",
+  "sources": [
+    "test.md"
+  ]
+}
+```

package/test/fixtures/scaffold-empty/explanation/explanation.md

@@ -0,0 +1,35 @@
+---
+title: "empty-package Explanation"
+type: "explanation"
+packageName: "empty-package"
+version: "0.0.1"
+generatedAt: "2025-12-26T20:10:17.162Z"
+confidenceScore: 0
+proof: "d10e1c3c48b31942bc49c4138fa54ceba73dd01cd79a814c2a0f323b198c9ba8"
+---
+
+## Concepts
+
+- (No concepts documented)
+
+## Architecture
+
+(No architecture documented)
+
+## Tradeoffs
+
+- (No tradeoffs documented)
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- (No sources recorded)
+
+```json
+{
+  "fingerprintInput": "|empty-package Explanation|0",
+  "hash": "d10e1c3c48b31942bc49c4138fa54ceba73dd01cd79a814c2a0f323b198c9ba8",
+  "sources": []
+}
+```

package/test/fixtures/scaffold-empty/index.md

@@ -0,0 +1,25 @@
+---
+title: "empty-package Documentation"
+packageName: "empty-package"
+version: "0.0.1"
+generatedAt: "2025-12-26T20:10:17.162Z"
+---
+
+# empty-package Documentation
+
+Generated documentation using the Diátaxis framework.
+
+## Quick Stats
+
+- **Tutorials**: 0
+- **How-To Guides**: 0
+- **Reference**: Not available
+- **Explanation**: Not available
+
+## Documentation Sections
+
+
+
+---
+
+*Generated at 2025-12-26T20:10:17.162Z*

package/test/fixtures/scaffold-empty/reference/reference.md

@@ -0,0 +1,34 @@
+---
+title: "empty-package Reference"
+type: "reference"
+packageName: "empty-package"
+version: "0.0.1"
+generatedAt: "2025-12-26T20:10:17.162Z"
+confidenceScore: 0
+proof: "2d17512c420e24c284f4f9c0e93c76b2c07ea1b78325009f886d17747df6cfc6"
+---
+
+## Overview
+
+This reference documentation provides technical details for empty-package.
+
+## API Reference
+
+| Name | Type | Description |
+|------|------|-------------|
+| - | - | (No items documented) |
+
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- (No sources recorded)
+
+```json
+{
+  "fingerprintInput": "|empty-package Reference|0",
+  "hash": "2d17512c420e24c284f4f9c0e93c76b2c07ea1b78325009f886d17747df6cfc6",
+  "sources": []
+}
+```

package/test/fixtures/scaffold-escape/explanation/explanation.md

@@ -0,0 +1,35 @@
+---
+title: "escape-test Explanation"
+type: "explanation"
+packageName: "escape-test"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.202Z"
+confidenceScore: 0
+proof: "cb3c88a8793cc92dfd46143689c8623844218d8349391e9daa41567614139499"
+---
+
+## Concepts
+
+- (No concepts documented)
+
+## Architecture
+
+(No architecture documented)
+
+## Tradeoffs
+
+- (No tradeoffs documented)
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- (No sources recorded)
+
+```json
+{
+  "fingerprintInput": "|escape-test Explanation|0",
+  "hash": "cb3c88a8793cc92dfd46143689c8623844218d8349391e9daa41567614139499",
+  "sources": []
+}
+```

package/test/fixtures/scaffold-escape/index.md

@@ -0,0 +1,29 @@
+---
+title: "escape-test Documentation"
+packageName: "escape-test"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.202Z"
+---
+
+# escape-test Documentation
+
+Generated documentation using the Diátaxis framework.
+
+## Quick Stats
+
+- **Tutorials**: 0
+- **How-To Guides**: 0
+- **Reference**: Available
+- **Explanation**: Not available
+
+## Documentation Sections
+
+### Reference
+
+- [Reference](reference/reference.md)
+
+
+
+---
+
+*Generated at 2025-12-26T20:10:17.202Z*

package/test/fixtures/scaffold-escape/reference/reference.md

@@ -0,0 +1,36 @@
+---
+title: "Reference"
+type: "reference"
+packageName: "escape-test"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.202Z"
+confidenceScore: 0.9
+proof: "8857370d6270a1bc31f7d5e4045fae4f9e463f366430be5bd543c7546cd1652e"
+---
+
+## Overview
+
+This reference documentation provides technical details for escape-test.
+
+## API Reference
+
+| Name | Type | Description |
+|------|------|-------------|
+| test\|pipe | export | Description with \| pipe |
+
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- test.md
+
+```json
+{
+  "fingerprintInput": "test.md|Reference|0.9",
+  "hash": "8857370d6270a1bc31f7d5e4045fae4f9e463f366430be5bd543c7546cd1652e",
+  "sources": [
+    "test.md"
+  ]
+}
+```

package/test/fixtures/scaffold-output/explanation/explanation.md

@@ -0,0 +1,39 @@
+---
+title: "Architecture"
+type: "explanation"
+packageName: "test-package"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.126Z"
+confidenceScore: 0.8
+proof: "7a544673d311153cefea152a2b46a655f60a985c32e1f6cd22c1c5a1df094b82"
+---
+
+## Concepts
+
+- Event-driven design
+- Plugin system
+
+## Architecture
+
+The system uses a modular architecture with plugins.
+
+## Tradeoffs
+
+- Performance vs flexibility
+- Memory vs speed
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- docs/architecture.md
+
+```json
+{
+  "fingerprintInput": "docs/architecture.md|Architecture|0.8",
+  "hash": "7a544673d311153cefea152a2b46a655f60a985c32e1f6cd22c1c5a1df094b82",
+  "sources": [
+    "docs/architecture.md"
+  ]
+}
+```

package/test/fixtures/scaffold-output/how-to/howto-configure-options.md

@@ -0,0 +1,39 @@
+---
+title: "Configure Options"
+type: "how-to"
+packageName: "test-package"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.126Z"
+confidenceScore: 0.85
+proof: "2581b7f7f9698a696a4f86cb63fb7a85c362988199a7bf9ad665397aee5f790b"
+---
+
+## Task
+
+Configure advanced options
+
+## Context
+
+When you need custom configuration
+
+## Steps
+
+1. Open config file
+2. Set options
+3. Validate config
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- docs/config.md
+
+```json
+{
+  "fingerprintInput": "docs/config.md|Configure Options|0.85",
+  "hash": "2581b7f7f9698a696a4f86cb63fb7a85c362988199a7bf9ad665397aee5f790b",
+  "sources": [
+    "docs/config.md"
+  ]
+}
+```

package/test/fixtures/scaffold-output/index.md

@@ -0,0 +1,41 @@
+---
+title: "test-package Documentation"
+packageName: "test-package"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.126Z"
+---
+
+# test-package Documentation
+
+Generated documentation using the Diátaxis framework.
+
+## Quick Stats
+
+- **Tutorials**: 1
+- **How-To Guides**: 1
+- **Reference**: Available
+- **Explanation**: Available
+
+## Documentation Sections
+
+### Tutorials
+
+- [Getting Started](tutorials/tutorial-getting-started.md)
+
+### How-To Guides
+
+- [Configure Options](how-to/howto-configure-options.md)
+
+### Reference
+
+- [API Reference](reference/reference.md)
+
+### Explanation
+
+- [Architecture](explanation/explanation.md)
+
+
+
+---
+
+*Generated at 2025-12-26T20:10:17.126Z*

package/test/fixtures/scaffold-output/reference/reference.md

@@ -0,0 +1,36 @@
+---
+title: "API Reference"
+type: "reference"
+packageName: "test-package"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.126Z"
+confidenceScore: 0.95
+proof: "dd195914e600c469aac3a7998e4820170ce963a6ee331fd357366d03339b9dfd"
+---
+
+## Overview
+
+This reference documentation provides technical details for test-package.
+
+## API Reference
+
+| Name | Type | Description |
+|------|------|-------------|
+| createClient | export | Creates a new client instance |
+
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- src/index.mjs
+
+```json
+{
+  "fingerprintInput": "src/index.mjs|API Reference|0.95",
+  "hash": "dd195914e600c469aac3a7998e4820170ce963a6ee331fd357366d03339b9dfd",
+  "sources": [
+    "src/index.mjs"
+  ]
+}
+```

package/test/fixtures/scaffold-output/tutorials/tutorial-getting-started.md

@@ -0,0 +1,41 @@
+---
+title: "Getting Started"
+type: "tutorial"
+packageName: "test-package"
+version: "1.0.0"
+generatedAt: "2025-12-26T20:10:17.126Z"
+confidenceScore: 0.9
+proof: "f63cc5a2e01b2001bbe58aefe40e432bbb623f7866afb2ee4ac3d52083afdec4"
+---
+
+## Overview
+
+Learn the basics
+
+## Prerequisites
+
+- Node.js 18+
+
+## Steps
+
+1. Install package
+2. Create config
+3. Run first command
+
+## Proof
+
+This file was generated from the following evidence sources:
+
+- README.md
+- docs/tutorial.md
+
+```json
+{
+  "fingerprintInput": "README.md|docs/tutorial.md|Getting Started|0.9",
+  "hash": "f63cc5a2e01b2001bbe58aefe40e432bbb623f7866afb2ee4ac3d52083afdec4",
+  "sources": [
+    "README.md",
+    "docs/tutorial.md"
+  ]
+}
+```

package/test/fixtures/test-artifacts/ARTIFACTS/diataxis/test-pkg-1.inventory.json

@@ -0,0 +1,115 @@
+{
+  "packageName": "@unrdf/test-pkg-1",
+  "version": "1.0.0",
+  "generatedAt": "2025-01-01T00:00:00.000Z",
+  "confidence": {
+    "tutorials": 0.9,
+    "howtos": 0.85,
+    "reference": 1,
+    "explanation": 0.8
+  },
+  "tutorials": [
+    {
+      "id": "tutorial-getting-started",
+      "title": "Getting Started",
+      "goal": "Learn basics",
+      "prerequisites": [],
+      "stepsOutline": [
+        "Install",
+        "Import",
+        "Use"
+      ],
+      "confidenceScore": 0.9,
+      "source": [
+        "readme",
+        "examples"
+      ]
+    }
+  ],
+  "howtos": [
+    {
+      "id": "howto-configure",
+      "title": "Configure Package",
+      "task": "Set up configuration",
+      "context": "When customizing",
+      "steps": [
+        "Create config",
+        "Set options"
+      ],
+      "confidenceScore": 0.85,
+      "source": [
+        "readme"
+      ]
+    },
+    {
+      "id": "howto-use-cli",
+      "title": "Use CLI",
+      "task": "Use command line",
+      "context": "When running CLI",
+      "steps": [
+        "Install",
+        "Run"
+      ],
+      "confidenceScore": 1,
+      "source": [
+        "bin"
+      ]
+    }
+  ],
+  "reference": {
+    "id": "reference-api",
+    "title": "API Reference",
+    "items": [
+      {
+        "name": "export1",
+        "type": "export",
+        "description": "Export 1",
+        "example": "import x"
+      },
+      {
+        "name": "cli-tool",
+        "type": "bin",
+        "description": "CLI tool",
+        "example": "cli-tool"
+      }
+    ],
+    "confidenceScore": 1,
+    "source": [
+      "exports",
+      "bin"
+    ]
+  },
+  "explanation": {
+    "id": "explanation-overview",
+    "title": "Understanding Package",
+    "concepts": [
+      "concept1",
+      "concept2"
+    ],
+    "architecture": "This is the architecture",
+    "tradeoffs": [
+      "Tradeoff 1",
+      "Tradeoff 2"
+    ],
+    "confidenceScore": 0.8,
+    "source": [
+      "readme",
+      "keywords"
+    ]
+  },
+  "evidence": {
+    "readmeHeadings": [
+      "Usage",
+      "API",
+      "Examples"
+    ],
+    "docsFiles": [
+      "guide.md"
+    ],
+    "examplesFiles": [
+      "example1.mjs",
+      "example2.mjs"
+    ],
+    "fingerprint": "abc123"
+  }
+}

package/test/fixtures/test-artifacts/ARTIFACTS/diataxis/test-pkg-2.inventory.json

@@ -0,0 +1,93 @@
+{
+  "packageName": "@unrdf/test-pkg-2",
+  "version": "0.5.0",
+  "generatedAt": "2025-01-01T00:00:00.000Z",
+  "confidence": {
+    "tutorials": 0.3,
+    "howtos": 0.4,
+    "reference": 0.5,
+    "explanation": 0.4
+  },
+  "tutorials": [
+    {
+      "id": "tutorial-basic",
+      "title": "Basic Tutorial",
+      "goal": "Learn",
+      "prerequisites": [],
+      "stepsOutline": [
+        "Step 1"
+      ],
+      "confidenceScore": 0.3,
+      "source": [
+        "inferred"
+      ]
+    }
+  ],
+  "howtos": [
+    {
+      "id": "howto-use",
+      "title": "Use Package",
+      "task": "Use it",
+      "context": "When needed",
+      "steps": [
+        "Import",
+        "Use"
+      ],
+      "confidenceScore": 0.4,
+      "source": [
+        "inferred"
+      ]
+    },
+    {
+      "id": "howto-troubleshoot",
+      "title": "Troubleshoot",
+      "task": "Fix issues",
+      "context": "When broken",
+      "steps": [
+        "Check",
+        "Fix"
+      ],
+      "confidenceScore": 0.4,
+      "source": [
+        "inferred"
+      ]
+    }
+  ],
+  "reference": {
+    "id": "reference-api",
+    "title": "API Reference",
+    "items": [
+      {
+        "name": "unknown",
+        "type": "unknown",
+        "description": "To be added",
+        "example": null
+      }
+    ],
+    "confidenceScore": 0.5,
+    "source": [
+      "inferred"
+    ]
+  },
+  "explanation": {
+    "id": "explanation-overview",
+    "title": "Understanding Package",
+    "concepts": [
+      "core"
+    ],
+    "architecture": "Basic package",
+    "tradeoffs": [
+      "Generic tradeoff"
+    ],
+    "confidenceScore": 0.4,
+    "source": [
+      "inferred"
+    ]
+  },
+  "evidence": {
+    "readmeHeadings": [],
+    "docsFiles": [],
+    "examplesFiles": [],
+    "fingerprint": "def456"
+  }
+}