spec-driven-docs 0.5.0

Spec-driven documentation: current specs, immutable decision records, and executable gates kept coherent for people and coding agents.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/gubasso/spec-driven-docs/blob/main/instance/manifest.schema.json",
  "type": "object",
  "required": [
    "schema_version",
    "canon_version",
    "canon_source",
    "profile",
    "docs_root",
    "installed_at",
    "managed_files",
    "adopted_files",
    "integration_blocks"
  ],
  "properties": {
    "schema_version": { "const": 3 },
    "canon_version": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" },
    "canon_source": { "type": "string", "minLength": 1 },
    "profile": { "enum": ["codebase", "knowledge-base"] },
    "docs_root": { "enum": ["docs", "_docs"] },
    "installed_at": { "type": "string", "format": "date-time" },
    "plan_zone": { "$ref": "#/$defs/plan_zone" },
    "docs_scratch": { "$ref": "#/$defs/relative_path" },
    "managed_files": { "$ref": "#/$defs/managed" },
    "adopted_files": { "$ref": "#/$defs/adopted" },
    "integration_blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["path", "marker_hash"],
        "properties": {
          "path": { "type": "string" },
          "marker_hash": { "$ref": "#/$defs/hash" }
        },
        "additionalProperties": false
      }
    }
  },
  "$defs": {
    "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
    "relative_path": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[^/]",
      "not": { "pattern": "^[.\\s/]*$" }
    },
    "confined_path": {
      "type": "string",
      "minLength": 1,
      "pattern": "^[^/]",
      "allOf": [
        { "not": { "pattern": "(^|/)\\.\\.(/|$)" } },
        { "not": { "pattern": "^[.\\s/]*$" } }
      ]
    },
    "plan_zone": {
      "type": "object",
      "oneOf": [
        {
          "required": ["kind", "path"],
          "properties": {
            "kind": { "enum": ["tracked", "untracked"] },
            "path": { "$ref": "#/$defs/confined_path" }
          },
          "additionalProperties": false
        },
        {
          "required": ["kind"],
          "properties": { "kind": { "enum": ["env", "none"] } },
          "additionalProperties": false
        }
      ]
    },
    "managed": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["source", "destination", "sha256"],
        "properties": {
          "source": { "type": "string" },
          "destination": { "type": "string" },
          "sha256": { "$ref": "#/$defs/hash" }
        },
        "additionalProperties": false
      }
    },
    "adopted": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["source", "destination", "sha256", "baseline_sha256"],
        "properties": {
          "source": { "type": "string" },
          "destination": { "type": "string" },
          "sha256": { "$ref": "#/$defs/hash" },
          "baseline_sha256": { "$ref": "#/$defs/hash" }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}