blob: cc3ec49d553cc6549d37bc41a45ef4376a13df6a (
plain)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
# Explanation
**Understanding-oriented documentation** - Concepts, design decisions, and the "why" behind ngit-grasp.
---
## What Is Explanation?
Explanation documentation helps you **understand concepts** and design decisions, providing context and discussing alternatives.
**Characteristics:**
- ✅ Understanding-oriented (clarify concepts)
- ✅ Theoretical (ideas and design)
- ✅ Discuss alternatives
- ✅ Provide context and background
- ✅ Answer "why" questions
**Not explanation:**
- ❌ Step-by-step lessons (those are Tutorials)
- ❌ Problem-solving recipes (those are How-To)
- ❌ Technical specifications (those are Reference)
---
## Available Explanation Documentation
### [Architecture Overview](architecture.md)
**Understand the system design and component interaction**
**Topics:**
- Overall architecture
- Component responsibilities
- Data flows
- Technology choices
- Design patterns
**Read when:** You want to understand how ngit-grasp works as a system
---
### [Inline Authorization](inline-authorization.md)
**Why we validate pushes inline instead of using Git hooks**
**Topics:**
- The authorization problem
- Git hooks approach
- Inline approach
- Comparison and trade-offs
- Implementation details
**Read when:** You want to understand the core architectural decision
---
### [Design Decisions](decisions.md)
**Key architectural choices and their rationale**
**Topics:**
- Inline authorization vs hooks
- Technology stack choices
- Storage design
- API design
- Performance considerations
**Read when:** You want to know why things are the way they are
---
### [Comparison with ngit-relay](comparison.md)
**How ngit-grasp differs from the reference implementation**
**Topics:**
- Architecture comparison
- Component differences
- Trade-offs
- Migration path
- Compatibility
**Read when:** You're familiar with ngit-relay and want to understand differences
---
## Planned Explanation Documentation
### GRASP Protocol Design
**Status:** 🔜 Planned
**Topics:**
- Why Nostr for Git?
- Authorization model
- Trust and verification
- Decentralization benefits
---
### Storage Architecture
**Status:** 🔜 Planned
**Topics:**
- Why separate Git and Nostr storage?
- Indexing strategy
- Performance considerations
- Scaling approach
---
### Testing Philosophy
**Status:** 🔜 Planned
**Topics:**
- Why test isolation?
- Integration vs unit tests
- Compliance testing approach
- Test-driven development
---
### Performance Considerations
**Status:** 🔜 Planned
**Topics:**
- Async architecture
- Caching strategy
- Database choices
- Bottlenecks and solutions
---
## How to Use Explanation Documentation
1. **Read to understand** - Not to accomplish a task
2. **Follow your curiosity** - Read what interests you
3. **Connect concepts** - Link ideas together
4. **Question and explore** - Think critically
**Not sure if this is what you need?**
- Want to learn by doing? → [Tutorials](../tutorials/)
- Need to solve a problem? → [How-To Guides](../how-to/)
- Looking for technical details? → [Reference](../reference/)
---
## Contributing Explanation Documentation
When writing explanation:
**DO:**
- ✅ Discuss concepts and ideas
- ✅ Provide context and background
- ✅ Explain alternatives
- ✅ Use analogies and examples
- ✅ Connect to broader context
- ✅ Answer "why" questions
**DON'T:**
- ❌ Provide step-by-step instructions (link to Tutorials/How-To)
- ❌ List technical details (link to Reference)
- ❌ Assume you must be comprehensive
- ❌ Avoid opinions (explanation can be opinionated)
**Template:**
```markdown
# Explanation: [Topic]
**Purpose:** [What concept/decision this explains]
**Audience:** [Who wants to understand this]
---
## The Problem/Question
[What are we trying to understand?]
---
## Background
[Context and history]
---
## Our Approach
[How we address it]
### Why This Works
[Explanation of benefits]
### Trade-offs
[What we gain and lose]
---
## Alternatives Considered
### [Alternative 1]
**Pros:**
- [Benefits]
**Cons:**
- [Drawbacks]
**Why we didn't choose it:**
[Reasoning]
---
## Conclusion
[Summary of understanding]
---
## Related Documentation
- [Links to relevant docs]
```
See [Diátaxis: Explanation](https://diataxis.fr/explanation/) for detailed guidance.
---
*Part of the [ngit-grasp documentation](../README.md) using the [Diátaxis](https://diataxis.fr/) framework.*
|