DocProcessor/VIDEO_COURSE.html at master · HelixDevelopment/DocProcessor · GitHub

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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>VIDEO_COURSE</title>
  <style>

html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
svg {
height: auto;
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
border: none;
border-top: 1px solid #1a1a1a;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">VIDEO_COURSE</h1>
</header>
<h1 id="video-course-docprocessor-deep-dive">Video Course: DocProcessor
Deep Dive</h1>
<p>5-episode series covering DocProcessor from fundamentals to advanced
usage.</p>
<hr />
<h2 id="episode-1-introduction--architecture-15-min">Episode 1:
Introduction &amp; Architecture (15 min)</h2>
<h3 id="script-outline">Script Outline</h3>
<ol type="1">
<li><p><strong>Opening</strong> (2 min)</p>
<ul>
<li>What is DocProcessor and why it exists</li>
<li>Role in the HelixQA ecosystem</li>
<li>Problem statement: manual QA doesn&#39;t scale</li>
</ul></li>
<li><p><strong>Architecture Overview</strong> (5 min)</p>
<ul>
<li>Package layout: loader, feature, coverage, docgraph, llm,
config</li>
<li>Processing pipeline visualization</li>
<li>Thread safety design with RWMutex</li>
</ul></li>
<li><p><strong>Quick Start Demo</strong> (5 min)</p>
<ul>
<li>Clone and build</li>
<li>Run CLI on sample docs</li>
<li>Show feature map output</li>
</ul></li>
<li><p><strong>Key Design Decisions</strong> (3 min)</p>
<ul>
<li>LLMAgent injection (no hard dependencies)</li>
<li>Deterministic feature IDs</li>
<li>Heuristic fallback when no LLM</li>
</ul></li>
</ol>
<hr />
<h2 id="episode-2-document-loading--parsing-15-min">Episode 2: Document
Loading &amp; Parsing (15 min)</h2>
<h3 id="script-outline-1">Script Outline</h3>
<ol type="1">
<li><p><strong>Loader Interface</strong> (3 min)</p>
<ul>
<li><code>LoadDir</code>, <code>LoadFile</code>,
<code>SupportedFormats</code></li>
<li>Context cancellation support</li>
<li>MaxFileSize protection</li>
</ul></li>
<li><p><strong>Markdown Parser</strong> (4 min)</p>
<ul>
<li>Heading extraction with regex</li>
<li>Section content segmentation</li>
<li>Link extraction and deduplication</li>
</ul></li>
<li><p><strong>YAML Parser</strong> (3 min)</p>
<ul>
<li>Generic unmarshalling</li>
<li>Title extraction from <code>title</code> or <code>name</code>
keys</li>
<li>Section creation from top-level keys</li>
</ul></li>
<li><p><strong>Scanner Implementation</strong> (3 min)</p>
<ul>
<li>Recursive directory walking</li>
<li>Hidden directory skipping</li>
<li>Extension normalization (yml -&gt; yaml)</li>
</ul></li>
<li><p><strong>Security</strong> (2 min)</p>
<ul>
<li>Path traversal protection</li>
<li>File size limits</li>
<li>Malformed input handling</li>
</ul></li>
</ol>
<hr />
<h2 id="episode-3-feature-extraction--featuremap-15-min">Episode 3:
Feature Extraction &amp; FeatureMap (15 min)</h2>
<h3 id="script-outline-2">Script Outline</h3>
<ol type="1">
<li><p><strong>Feature Model</strong> (3 min)</p>
<ul>
<li>Feature struct: ID, Name, Category, Platforms, Priority</li>
<li>FeatureCategory constants</li>
<li>Deterministic ID generation</li>
</ul></li>
<li><p><strong>Heuristic Extraction</strong> (3 min)</p>
<ul>
<li>Section-based extraction</li>
<li>Content length thresholds</li>
<li>Default platform assignment</li>
</ul></li>
<li><p><strong>LLM-Powered Extraction</strong> (4 min)</p>
<ul>
<li>LLMAgent interface design</li>
<li>Prompt templates with versioning</li>
<li>ExtractFeatures, ClassifyFeature flow</li>
</ul></li>
<li><p><strong>FeatureMap Building</strong> (3 min)</p>
<ul>
<li>AddFeature with category/platform indexing</li>
<li>DocGraph integration</li>
<li>FeatureByID, FeaturesForPlatform queries</li>
</ul></li>
<li><p><strong>Merge &amp; Deduplication</strong> (2 min)</p>
<ul>
<li>Merging multiple feature maps</li>
<li>ID-based deduplication</li>
<li>DocGraph merging</li>
</ul></li>
</ol>
<hr />
<h2 id="episode-4-coverage-tracking-15-min">Episode 4: Coverage Tracking
(15 min)</h2>
<h3 id="script-outline-3">Script Outline</h3>
<ol type="1">
<li><p><strong>CoverageTracker Interface</strong> (3 min)</p>
<ul>
<li>RegisterFeature, MarkVerified, MarkFailed, MarkSkipped</li>
<li>Coverage reports by platform and category</li>
<li>Export for serialization</li>
</ul></li>
<li><p><strong>Thread-Safe Implementation</strong> (4 min)</p>
<ul>
<li>sync.RWMutex usage</li>
<li>Read path: RLock for Coverage(), CoverageByPlatform(),
Unverified()</li>
<li>Write path: Lock for MarkVerified(), MarkFailed(),
MarkSkipped()</li>
</ul></li>
<li><p><strong>Verification States</strong> (3 min)</p>
<ul>
<li>State machine: unverified -&gt; verified/failed/skipped</li>
<li>State transitions and overwrites</li>
<li>Evidence and Issue tracking</li>
</ul></li>
<li><p><strong>Reporting</strong> (3 min)</p>
<ul>
<li>CoverageReport aggregation</li>
<li>Platform and category breakdowns</li>
<li>Issue collection</li>
</ul></li>
<li><p><strong>Stress Testing</strong> (2 min)</p>
<ul>
<li>Concurrent verification from multiple platform workers</li>
<li>Race condition detection</li>
<li>High-contention scenarios</li>
</ul></li>
</ol>
<hr />
<h2 id="episode-5-docgraph--integration-15-min">Episode 5: DocGraph
&amp; Integration (15 min)</h2>
<h3 id="script-outline-4">Script Outline</h3>
<ol type="1">
<li><p><strong>DocGraph</strong> (4 min)</p>
<ul>
<li>Directed graph of document links</li>
<li>Node and edge management</li>
<li>Neighbor and incoming edge queries</li>
</ul></li>
<li><p><strong>Export Formats</strong> (3 min)</p>
<ul>
<li>JSON export and import (round-trip)</li>
<li>Mermaid diagram generation</li>
<li>ID sanitization for Mermaid</li>
</ul></li>
<li><p><strong>Full Pipeline Integration</strong> (4 min)</p>
<ul>
<li>Load -&gt; Parse -&gt; Extract -&gt; Build -&gt; Enrich -&gt;
Track</li>
<li>Mock LLMAgent for testing</li>
<li>E2E test walkthrough</li>
</ul></li>
<li><p><strong>Configuration</strong> (2 min)</p>
<ul>
<li>.env file loading</li>
<li>Default values</li>
<li>Environment variable mapping</li>
</ul></li>
<li><p><strong>What&#39;s Next</strong> (2 min)</p>
<ul>
<li>HelixQA integration via bridge adapters</li>
<li>LLMOrchestrator Agent -&gt; LLMAgent adapter</li>
<li>Autonomous QA session pipeline</li>
</ul></li>
</ol>
</body>
</html>