diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2025-11-04 10:25:53 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2025-11-04 10:25:53 +0000 |
| commit | 52bad9954cdddf55ab749fd0c6387edbc766632f (patch) | |
| tree | d9dd2078b70a627a71d1adb9555cee83faec5cd0 /docs/reference/README.md | |
| parent | db460efdd4cf34d3b6ac8c19b1b8f89f22bc279f (diff) | |
docs: use Diátaxis structure
Diffstat (limited to 'docs/reference/README.md')
| -rw-r--r-- | docs/reference/README.md | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/docs/reference/README.md b/docs/reference/README.md new file mode 100644 index 0000000..96fc5ed --- /dev/null +++ b/docs/reference/README.md | |||
| @@ -0,0 +1,201 @@ | |||
| 1 | # Reference | ||
| 2 | |||
| 3 | **Information-oriented documentation** - Technical details and specifications. | ||
| 4 | |||
| 5 | --- | ||
| 6 | |||
| 7 | ## What Is Reference Documentation? | ||
| 8 | |||
| 9 | Reference documentation provides **factual, technical information** that you look up when needed. | ||
| 10 | |||
| 11 | **Characteristics:** | ||
| 12 | - ✅ Information-oriented (facts and data) | ||
| 13 | - ✅ Comprehensive and accurate | ||
| 14 | - ✅ Structured for lookup | ||
| 15 | - ✅ Dry and to-the-point | ||
| 16 | - ✅ Maintained as code changes | ||
| 17 | |||
| 18 | **Not reference:** | ||
| 19 | - ❌ Learning materials (those are Tutorials) | ||
| 20 | - ❌ Problem-solving guides (those are How-To) | ||
| 21 | - ❌ Conceptual explanations (those are Explanation) | ||
| 22 | |||
| 23 | --- | ||
| 24 | |||
| 25 | ## Available Reference Documentation | ||
| 26 | |||
| 27 | ### [Configuration](configuration.md) | ||
| 28 | **Complete reference for all configuration options** | ||
| 29 | |||
| 30 | **Contents:** | ||
| 31 | - Environment variables | ||
| 32 | - Configuration file format | ||
| 33 | - Validation rules | ||
| 34 | - Examples for development/production/testing | ||
| 35 | |||
| 36 | **Use when:** You need to know what a config option does or what values are valid | ||
| 37 | |||
| 38 | --- | ||
| 39 | |||
| 40 | ### [Git Protocol](git-protocol.md) | ||
| 41 | **Git Smart HTTP protocol specification** | ||
| 42 | |||
| 43 | **Contents:** | ||
| 44 | - Protocol overview | ||
| 45 | - Pkt-line format | ||
| 46 | - Request/response structure | ||
| 47 | - Reference updates format | ||
| 48 | - Parsing examples | ||
| 49 | |||
| 50 | **Use when:** You need to understand Git HTTP internals | ||
| 51 | |||
| 52 | --- | ||
| 53 | |||
| 54 | ### [Test Strategy](test-strategy.md) | ||
| 55 | **Testing approach and compliance framework** | ||
| 56 | |||
| 57 | **Contents:** | ||
| 58 | - Test categories (unit, integration, compliance) | ||
| 59 | - GRASP compliance requirements | ||
| 60 | - Test isolation strategy | ||
| 61 | - Running tests | ||
| 62 | - Coverage requirements | ||
| 63 | |||
| 64 | **Use when:** You're writing tests or need to understand test structure | ||
| 65 | |||
| 66 | --- | ||
| 67 | |||
| 68 | ## Planned Reference Documentation | ||
| 69 | |||
| 70 | ### GRASP Protocol | ||
| 71 | **Status:** 🔜 Planned | ||
| 72 | |||
| 73 | **Contents:** | ||
| 74 | - GRASP-01 requirements | ||
| 75 | - GRASP-02 (Proactive Sync) | ||
| 76 | - GRASP-05 (Archive) | ||
| 77 | - Event formats | ||
| 78 | - Validation rules | ||
| 79 | |||
| 80 | --- | ||
| 81 | |||
| 82 | ### API Reference | ||
| 83 | **Status:** 🔜 Planned (waiting for main server) | ||
| 84 | |||
| 85 | **Contents:** | ||
| 86 | - HTTP endpoints | ||
| 87 | - Request/response formats | ||
| 88 | - Error codes | ||
| 89 | - Authentication | ||
| 90 | - Rate limiting | ||
| 91 | |||
| 92 | --- | ||
| 93 | |||
| 94 | ### nostr-sdk Upgrade Guide | ||
| 95 | **Status:** 🔜 Planned | ||
| 96 | |||
| 97 | **Contents:** | ||
| 98 | - Version compatibility matrix | ||
| 99 | - Breaking changes by version | ||
| 100 | - Migration examples | ||
| 101 | - Common patterns | ||
| 102 | |||
| 103 | --- | ||
| 104 | |||
| 105 | ### Event Formats | ||
| 106 | **Status:** 🔜 Planned | ||
| 107 | |||
| 108 | **Contents:** | ||
| 109 | - NIP-34 repository announcements (kind 30317) | ||
| 110 | - NIP-34 state events (kind 30318) | ||
| 111 | - Custom tags | ||
| 112 | - Validation rules | ||
| 113 | |||
| 114 | --- | ||
| 115 | |||
| 116 | ### CLI Reference | ||
| 117 | **Status:** 🔜 Planned | ||
| 118 | |||
| 119 | **Contents:** | ||
| 120 | - Command-line arguments | ||
| 121 | - Subcommands | ||
| 122 | - Environment variables | ||
| 123 | - Exit codes | ||
| 124 | |||
| 125 | --- | ||
| 126 | |||
| 127 | ## How to Use Reference Documentation | ||
| 128 | |||
| 129 | 1. **Know what you're looking for** - Reference is for lookup, not learning | ||
| 130 | 2. **Use search or table of contents** - Find the specific detail you need | ||
| 131 | 3. **Check version** - Ensure docs match your version | ||
| 132 | 4. **Verify with code** - Reference should match implementation | ||
| 133 | |||
| 134 | **Not sure if this is what you need?** | ||
| 135 | - New to the topic? → [Tutorials](../tutorials/) | ||
| 136 | - Trying to solve a problem? → [How-To Guides](../how-to/) | ||
| 137 | - Want to understand concepts? → [Explanation](../explanation/) | ||
| 138 | |||
| 139 | --- | ||
| 140 | |||
| 141 | ## Contributing Reference Documentation | ||
| 142 | |||
| 143 | When writing reference documentation: | ||
| 144 | |||
| 145 | **DO:** | ||
| 146 | - ✅ Be accurate and complete | ||
| 147 | - ✅ Use consistent structure | ||
| 148 | - ✅ Include all options/parameters | ||
| 149 | - ✅ Provide examples | ||
| 150 | - ✅ Update when code changes | ||
| 151 | - ✅ Use tables for structured data | ||
| 152 | |||
| 153 | **DON'T:** | ||
| 154 | - ❌ Explain concepts (link to Explanation) | ||
| 155 | - ❌ Provide tutorials (link to Tutorials) | ||
| 156 | - ❌ Solve problems (link to How-To) | ||
| 157 | - ❌ Include opinions or recommendations | ||
| 158 | |||
| 159 | **Template:** | ||
| 160 | ```markdown | ||
| 161 | # Reference: [Topic] | ||
| 162 | |||
| 163 | **Purpose:** [What this reference covers] | ||
| 164 | **Audience:** [Who needs this information] | ||
| 165 | |||
| 166 | --- | ||
| 167 | |||
| 168 | ## Overview | ||
| 169 | |||
| 170 | [Brief description of what's being documented] | ||
| 171 | |||
| 172 | --- | ||
| 173 | |||
| 174 | ## [Section 1] | ||
| 175 | |||
| 176 | ### [Item] | ||
| 177 | |||
| 178 | **Description:** [What it is/does] | ||
| 179 | **Type:** [Data type] | ||
| 180 | **Default:** [Default value] | ||
| 181 | **Required:** [Yes/No] | ||
| 182 | |||
| 183 | **Examples:** | ||
| 184 | \`\`\` | ||
| 185 | [Example usage] | ||
| 186 | \`\`\` | ||
| 187 | |||
| 188 | **Notes:** | ||
| 189 | - [Important details] | ||
| 190 | |||
| 191 | --- | ||
| 192 | |||
| 193 | ## Related Documentation | ||
| 194 | - [Links to relevant docs] | ||
| 195 | ``` | ||
| 196 | |||
| 197 | See [Diátaxis: Reference](https://diataxis.fr/reference/) for detailed guidance. | ||
| 198 | |||
| 199 | --- | ||
| 200 | |||
| 201 | *Part of the [ngit-grasp documentation](../README.md) using the [Diátaxis](https://diataxis.fr/) framework.* | ||