Skip to content

Commit ca8a2fc

Browse files
committed
docs: add DIP quickstart and developer guide
1 parent e712e1f commit ca8a2fc

2 files changed

Lines changed: 260 additions & 0 deletions

File tree

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
\# DIP Developer Guide
2+
3+
4+
5+
This guide explains how developers can integrate the
6+
7+
Decision Integrity Protocol into automated systems.
8+
9+
10+
11+
---
12+
13+
14+
15+
\# Decision Workflow
16+
17+
18+
19+
Typical system integration:
20+
21+
22+
23+
24+
25+
application
26+
27+
28+
29+
decision.json
30+
31+
32+
33+
dip sign
34+
35+
36+
37+
artifact.json
38+
39+
40+
41+
dip proof
42+
43+
44+
45+
proof.json
46+
47+
48+
49+
50+
51+
---
52+
53+
54+
55+
\# Integration Pattern
56+
57+
58+
59+
Applications generate decision records
60+
61+
and pass them to the DIP CLI.
62+
63+
64+
65+
Example workflow:
66+
67+
68+
69+
1 Generate decision record
70+
71+
2 Sign the decision
72+
73+
3 Append artifact to registry
74+
75+
4 Generate proof
76+
77+
5 Store bundle
78+
79+
80+
81+
---
82+
83+
84+
85+
\# Verification
86+
87+
88+
89+
Verification can occur in any environment.
90+
91+
92+
93+
The verifier requires only:
94+
95+
96+
97+
98+
99+
artifact
100+
101+
proof
102+
103+
verifier
104+
105+
106+
107+
108+
109+
---
110+
111+
112+
113+
\# Example Use Cases
114+
115+
116+
117+
Infrastructure deployment verification
118+
119+
120+
121+
Automated policy enforcement
122+
123+
124+
125+
Access control decision tracking
126+
127+
128+
129+
Financial decision auditing
130+

docs/developer/DIP_QUICKSTART.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
\# DIP Quickstart
2+
3+
4+
5+
This guide shows how to create and verify a decision artifact
6+
7+
using the Decision Integrity Protocol.
8+
9+
10+
11+
\## 1 Create a Decision Record
12+
13+
14+
15+
Create a file named `decision.json`.
16+
17+
18+
19+
Example:
20+
21+
22+
23+
```json
24+
25+
{
26+
27+
  "decision\_id": "deploy-001",
28+
29+
  "timestamp": "2026-03-07T10:00:00Z",
30+
31+
  "inputs": {
32+
33+
  "environment": "production"
34+
35+
  },
36+
37+
  "outputs": {
38+
39+
  "approved": true
40+
41+
  }
42+
43+
}
44+
45+
2 Generate an Artifact
46+
47+
48+
49+
Run:
50+
51+
52+
53+
dip sign decision.json
54+
55+
56+
57+
Output:
58+
59+
60+
61+
artifact.json
62+
63+
3 Generate a Proof
64+
65+
66+
67+
Run:
68+
69+
70+
71+
dip proof artifact.json
72+
73+
74+
75+
Output:
76+
77+
78+
79+
proof.json
80+
81+
4 Create a Bundle
82+
83+
84+
85+
Run:
86+
87+
88+
89+
dip bundle artifact.json proof.json
90+
91+
92+
93+
Output:
94+
95+
96+
97+
decision.dip
98+
99+
5 Verify the Artifact
100+
101+
102+
103+
Run:
104+
105+
106+
107+
dip verify decision.dip
108+
109+
110+
111+
Output:
112+
113+
114+
115+
DIP bundle verification: VALID
116+
117+
Protocol Guarantee
118+
119+
120+
121+
Verification requires only:
122+
123+
124+
125+
artifact + proof + verifier = truth
126+
127+
128+
129+
No access to the original system is required.
130+

0 commit comments

Comments
 (0)