blob: 96fc5ed7cd08e212d0251db9c254ec48b79ee34b (
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
|
# Reference
**Information-oriented documentation** - Technical details and specifications.
---
## What Is Reference Documentation?
Reference documentation provides **factual, technical information** that you look up when needed.
**Characteristics:**
- ✅ Information-oriented (facts and data)
- ✅ Comprehensive and accurate
- ✅ Structured for lookup
- ✅ Dry and to-the-point
- ✅ Maintained as code changes
**Not reference:**
- ❌ Learning materials (those are Tutorials)
- ❌ Problem-solving guides (those are How-To)
- ❌ Conceptual explanations (those are Explanation)
---
## Available Reference Documentation
### [Configuration](configuration.md)
**Complete reference for all configuration options**
**Contents:**
- Environment variables
- Configuration file format
- Validation rules
- Examples for development/production/testing
**Use when:** You need to know what a config option does or what values are valid
---
### [Git Protocol](git-protocol.md)
**Git Smart HTTP protocol specification**
**Contents:**
- Protocol overview
- Pkt-line format
- Request/response structure
- Reference updates format
- Parsing examples
**Use when:** You need to understand Git HTTP internals
---
### [Test Strategy](test-strategy.md)
**Testing approach and compliance framework**
**Contents:**
- Test categories (unit, integration, compliance)
- GRASP compliance requirements
- Test isolation strategy
- Running tests
- Coverage requirements
**Use when:** You're writing tests or need to understand test structure
---
## Planned Reference Documentation
### GRASP Protocol
**Status:** 🔜 Planned
**Contents:**
- GRASP-01 requirements
- GRASP-02 (Proactive Sync)
- GRASP-05 (Archive)
- Event formats
- Validation rules
---
### API Reference
**Status:** 🔜 Planned (waiting for main server)
**Contents:**
- HTTP endpoints
- Request/response formats
- Error codes
- Authentication
- Rate limiting
---
### nostr-sdk Upgrade Guide
**Status:** 🔜 Planned
**Contents:**
- Version compatibility matrix
- Breaking changes by version
- Migration examples
- Common patterns
---
### Event Formats
**Status:** 🔜 Planned
**Contents:**
- NIP-34 repository announcements (kind 30317)
- NIP-34 state events (kind 30318)
- Custom tags
- Validation rules
---
### CLI Reference
**Status:** 🔜 Planned
**Contents:**
- Command-line arguments
- Subcommands
- Environment variables
- Exit codes
---
## How to Use Reference Documentation
1. **Know what you're looking for** - Reference is for lookup, not learning
2. **Use search or table of contents** - Find the specific detail you need
3. **Check version** - Ensure docs match your version
4. **Verify with code** - Reference should match implementation
**Not sure if this is what you need?**
- New to the topic? → [Tutorials](../tutorials/)
- Trying to solve a problem? → [How-To Guides](../how-to/)
- Want to understand concepts? → [Explanation](../explanation/)
---
## Contributing Reference Documentation
When writing reference documentation:
**DO:**
- ✅ Be accurate and complete
- ✅ Use consistent structure
- ✅ Include all options/parameters
- ✅ Provide examples
- ✅ Update when code changes
- ✅ Use tables for structured data
**DON'T:**
- ❌ Explain concepts (link to Explanation)
- ❌ Provide tutorials (link to Tutorials)
- ❌ Solve problems (link to How-To)
- ❌ Include opinions or recommendations
**Template:**
```markdown
# Reference: [Topic]
**Purpose:** [What this reference covers]
**Audience:** [Who needs this information]
---
## Overview
[Brief description of what's being documented]
---
## [Section 1]
### [Item]
**Description:** [What it is/does]
**Type:** [Data type]
**Default:** [Default value]
**Required:** [Yes/No]
**Examples:**
\`\`\`
[Example usage]
\`\`\`
**Notes:**
- [Important details]
---
## Related Documentation
- [Links to relevant docs]
```
See [Diátaxis: Reference](https://diataxis.fr/reference/) for detailed guidance.
---
*Part of the [ngit-grasp documentation](../README.md) using the [Diátaxis](https://diataxis.fr/) framework.*
|