create-zudo-circuit-doc 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +21 -0
  3. package/README.md +58 -0
  4. package/bin/create-zudo-circuit-doc.js +6 -0
  5. package/dist/args.d.ts +21 -0
  6. package/dist/args.js +71 -0
  7. package/dist/cli.d.ts +27 -0
  8. package/dist/cli.js +101 -0
  9. package/dist/errors.d.ts +4 -0
  10. package/dist/errors.js +7 -0
  11. package/dist/git.d.ts +11 -0
  12. package/dist/git.js +69 -0
  13. package/dist/help.d.ts +2 -0
  14. package/dist/help.js +21 -0
  15. package/dist/install.d.ts +3 -0
  16. package/dist/install.js +17 -0
  17. package/dist/next-steps.d.ts +10 -0
  18. package/dist/next-steps.js +24 -0
  19. package/dist/plan.d.ts +17 -0
  20. package/dist/plan.js +59 -0
  21. package/dist/prompt.d.ts +3 -0
  22. package/dist/prompt.js +12 -0
  23. package/dist/scaffold.d.ts +22 -0
  24. package/dist/scaffold.js +187 -0
  25. package/dist/shell-quote.d.ts +2 -0
  26. package/dist/shell-quote.js +7 -0
  27. package/dist/validate.d.ts +18 -0
  28. package/dist/validate.js +85 -0
  29. package/dist/version.d.ts +6 -0
  30. package/dist/version.js +13 -0
  31. package/package.json +49 -0
  32. package/templates/default/.claude/skills/circuit-spec-integration/SKILL.md +22 -0
  33. package/templates/default/.claude/skills/circuit-spec-integration/references/rules.json +4 -0
  34. package/templates/default/.claude/skills/component-spec-audit/SKILL.md +36 -0
  35. package/templates/default/.claude/skills/component-spec-audit/references/contract.md +21 -0
  36. package/templates/default/.claude/skills/component-spec-audit/references/direct-routing.json +5 -0
  37. package/templates/default/.claude/skills/component-spec-audit/references/external-vendor-qualifiers.json +4 -0
  38. package/templates/default/.claude/skills/component-spec-audit/references/inventory.json +11 -0
  39. package/templates/default/.claude/skills/component-spec-audit/references/new-component-workflow.md +113 -0
  40. package/templates/default/AGENTS.md +7 -0
  41. package/templates/default/CLAUDE.md +7 -0
  42. package/templates/default/README.md +49 -0
  43. package/templates/default/ZUDO_DEPS_PINS.md +48 -0
  44. package/templates/default/_gitignore +25 -0
  45. package/templates/default/circuit/WORKFLOW.md +361 -0
  46. package/templates/default/circuit/agent-task-examples.md +178 -0
  47. package/templates/default/circuit/checks/README.md +37 -0
  48. package/templates/default/circuit/generated/preflight.json +625 -0
  49. package/templates/default/circuit/publication/assets.json +9 -0
  50. package/templates/default/circuit/publication/selection.json +13 -0
  51. package/templates/default/circuit/templates/README.md +33 -0
  52. package/templates/default/circuit/templates/cad-asset-receipt.json +58 -0
  53. package/templates/default/circuit/templates/cad-asset-receipt.md +33 -0
  54. package/templates/default/circuit/templates/project-docs/architecture/interfaces.mdx +52 -0
  55. package/templates/default/circuit/templates/project-docs/architecture/overview.mdx +55 -0
  56. package/templates/default/circuit/templates/project-docs/decisions/decision.mdx +66 -0
  57. package/templates/default/circuit/templates/project-docs/decisions/sourcing.mdx +57 -0
  58. package/templates/default/circuit/templates/project-docs/project/change-impact.mdx +61 -0
  59. package/templates/default/circuit/templates/project-docs/project/index.mdx +62 -0
  60. package/templates/default/circuit/templates/project-docs/project/next-actions.mdx +58 -0
  61. package/templates/default/circuit/templates/project-docs/project/task-request.mdx +56 -0
  62. package/templates/default/circuit/templates/project-docs/research/component-candidate.mdx +60 -0
  63. package/templates/default/circuit/templates/project-docs/verification/bring-up.mdx +55 -0
  64. package/templates/default/circuit.config.ts +36 -0
  65. package/templates/default/doc/package.json +37 -0
  66. package/templates/default/doc/pages/docs/[[...slug]].tsx +68 -0
  67. package/templates/default/doc/pages/index.tsx +6 -0
  68. package/templates/default/doc/pages/lib/_circuit-doc-islands.ts +4 -0
  69. package/templates/default/doc/public/favicon-16x16.png +0 -0
  70. package/templates/default/doc/public/favicon-32x32.png +0 -0
  71. package/templates/default/doc/public/favicon.ico +0 -0
  72. package/templates/default/doc/public/favicon.svg +4 -0
  73. package/templates/default/doc/scripts/check-links.js +969 -0
  74. package/templates/default/doc/src/chrome-bindings.tsx +11 -0
  75. package/templates/default/doc/src/content/docs/architecture/index.mdx +11 -0
  76. package/templates/default/doc/src/content/docs/architecture/overview.mdx +55 -0
  77. package/templates/default/doc/src/content/docs/components/catalog/index.mdx +12 -0
  78. package/templates/default/doc/src/content/docs/components/index.mdx +49 -0
  79. package/templates/default/doc/src/content/docs/components/integration/index.mdx +34 -0
  80. package/templates/default/doc/src/content/docs/components/records/index.mdx +14 -0
  81. package/templates/default/doc/src/content/docs/decisions/index.mdx +9 -0
  82. package/templates/default/doc/src/content/docs/project/how-we-work.mdx +67 -0
  83. package/templates/default/doc/src/content/docs/project/index.mdx +60 -0
  84. package/templates/default/doc/src/content/docs/project/next-actions.mdx +58 -0
  85. package/templates/default/doc/src/content/docs/research/index.mdx +9 -0
  86. package/templates/default/doc/src/content/docs/verification/index.mdx +9 -0
  87. package/templates/default/doc/src/styles/global.css +31 -0
  88. package/templates/default/doc/tsconfig.json +13 -0
  89. package/templates/default/doc/zfb.config.ts +78 -0
  90. package/templates/default/package.json +23 -0
  91. package/templates/default/pnpm-workspace.yaml +9 -0
@@ -0,0 +1,625 @@
1
+ {
2
+ "viewModelVersion": 2,
3
+ "provider": {
4
+ "id": "circuit-component-spec",
5
+ "contractVersion": 1
6
+ },
7
+ "records": {
8
+ "available": 0,
9
+ "selected": 0,
10
+ "slugs": []
11
+ },
12
+ "sources": {
13
+ "available": 0,
14
+ "selected": 0,
15
+ "linkable": 0,
16
+ "ids": []
17
+ },
18
+ "fields": [
19
+ {
20
+ "key": "record.recordId",
21
+ "decision": "PUBLISH",
22
+ "emitted": 0,
23
+ "withheld": 0
24
+ },
25
+ {
26
+ "key": "record.slug",
27
+ "decision": "PUBLISH",
28
+ "emitted": 0,
29
+ "withheld": 0
30
+ },
31
+ {
32
+ "key": "record.kind",
33
+ "decision": "PUBLISH",
34
+ "emitted": 0,
35
+ "withheld": 0
36
+ },
37
+ {
38
+ "key": "record.parentRecordId",
39
+ "decision": "PUBLISH",
40
+ "emitted": 0,
41
+ "withheld": 0
42
+ },
43
+ {
44
+ "key": "record.lineId",
45
+ "decision": "PUBLISH",
46
+ "emitted": 0,
47
+ "withheld": 0
48
+ },
49
+ {
50
+ "key": "record.ownerSkill",
51
+ "decision": "PUBLISH",
52
+ "emitted": 0,
53
+ "withheld": 0
54
+ },
55
+ {
56
+ "key": "record.mpn",
57
+ "decision": "PUBLISH",
58
+ "emitted": 0,
59
+ "withheld": 0
60
+ },
61
+ {
62
+ "key": "record.manufacturer",
63
+ "decision": "PUBLISH",
64
+ "emitted": 0,
65
+ "withheld": 0
66
+ },
67
+ {
68
+ "key": "record.lcsc",
69
+ "decision": "PUBLISH",
70
+ "emitted": 0,
71
+ "withheld": 0
72
+ },
73
+ {
74
+ "key": "record.package",
75
+ "decision": "PUBLISH",
76
+ "emitted": 0,
77
+ "withheld": 0
78
+ },
79
+ {
80
+ "key": "record.function",
81
+ "decision": "PUBLISH",
82
+ "emitted": 0,
83
+ "withheld": 0
84
+ },
85
+ {
86
+ "key": "record.identityState",
87
+ "decision": "PUBLISH",
88
+ "emitted": 0,
89
+ "withheld": 0
90
+ },
91
+ {
92
+ "key": "record.sourceState",
93
+ "decision": "PUBLISH",
94
+ "emitted": 0,
95
+ "withheld": 0
96
+ },
97
+ {
98
+ "key": "record.dnp",
99
+ "decision": "PUBLISH",
100
+ "emitted": 0,
101
+ "withheld": 0
102
+ },
103
+ {
104
+ "key": "record.placements",
105
+ "decision": "PUBLISH",
106
+ "emitted": 0,
107
+ "withheld": 0
108
+ },
109
+ {
110
+ "key": "alias.mpn",
111
+ "decision": "PUBLISH",
112
+ "emitted": 0,
113
+ "withheld": 0
114
+ },
115
+ {
116
+ "key": "alias.lcsc",
117
+ "decision": "PUBLISH",
118
+ "emitted": 0,
119
+ "withheld": 0
120
+ },
121
+ {
122
+ "key": "alias.manufacturer",
123
+ "decision": "PUBLISH",
124
+ "emitted": 0,
125
+ "withheld": 0
126
+ },
127
+ {
128
+ "key": "alias.function",
129
+ "decision": "PUBLISH",
130
+ "emitted": 0,
131
+ "withheld": 0
132
+ },
133
+ {
134
+ "key": "routing.positivePrompts",
135
+ "decision": "DENY",
136
+ "emitted": 0,
137
+ "withheld": 0
138
+ },
139
+ {
140
+ "key": "routing.negativePrompts",
141
+ "decision": "DENY",
142
+ "emitted": 0,
143
+ "withheld": 0
144
+ },
145
+ {
146
+ "key": "source.sourceId",
147
+ "decision": "PUBLISH",
148
+ "emitted": 0,
149
+ "withheld": 0
150
+ },
151
+ {
152
+ "key": "source.documentTitle",
153
+ "decision": "PUBLISH",
154
+ "emitted": 0,
155
+ "withheld": 0
156
+ },
157
+ {
158
+ "key": "source.documentNumber",
159
+ "decision": "PUBLISH",
160
+ "emitted": 0,
161
+ "withheld": 0
162
+ },
163
+ {
164
+ "key": "source.revision",
165
+ "decision": "PUBLISH",
166
+ "emitted": 0,
167
+ "withheld": 0
168
+ },
169
+ {
170
+ "key": "source.documentDate",
171
+ "decision": "PUBLISH",
172
+ "emitted": 0,
173
+ "withheld": 0
174
+ },
175
+ {
176
+ "key": "source.retrievalDate",
177
+ "decision": "PUBLISH",
178
+ "emitted": 0,
179
+ "withheld": 0
180
+ },
181
+ {
182
+ "key": "source.authorityClass",
183
+ "decision": "PUBLISH",
184
+ "emitted": 0,
185
+ "withheld": 0
186
+ },
187
+ {
188
+ "key": "source.availability",
189
+ "decision": "PUBLISH",
190
+ "emitted": 0,
191
+ "withheld": 0
192
+ },
193
+ {
194
+ "key": "source.locator",
195
+ "decision": "PUBLISH",
196
+ "emitted": 0,
197
+ "withheld": 0
198
+ },
199
+ {
200
+ "key": "source.printedPageLabel",
201
+ "decision": "PUBLISH",
202
+ "emitted": 0,
203
+ "withheld": 0
204
+ },
205
+ {
206
+ "key": "source.physicalPdfPageIndex",
207
+ "decision": "DENY",
208
+ "emitted": 0,
209
+ "withheld": 0
210
+ },
211
+ {
212
+ "key": "source.authoritativeUrl",
213
+ "decision": "PUBLISH",
214
+ "emitted": 0,
215
+ "withheld": 0
216
+ },
217
+ {
218
+ "key": "source.alternateAuthoritativeUrl",
219
+ "decision": "DENY",
220
+ "emitted": 0,
221
+ "withheld": 0
222
+ },
223
+ {
224
+ "key": "source.sha256",
225
+ "decision": "DENY",
226
+ "emitted": 0,
227
+ "withheld": 0
228
+ },
229
+ {
230
+ "key": "source.evidenceExtract",
231
+ "decision": "DENY",
232
+ "emitted": 0,
233
+ "withheld": 0
234
+ },
235
+ {
236
+ "key": "fact.factId",
237
+ "decision": "PUBLISH",
238
+ "emitted": 0,
239
+ "withheld": 0
240
+ },
241
+ {
242
+ "key": "fact.class",
243
+ "decision": "PUBLISH",
244
+ "emitted": 0,
245
+ "withheld": 0
246
+ },
247
+ {
248
+ "key": "fact.value",
249
+ "decision": "PUBLISH",
250
+ "emitted": 0,
251
+ "withheld": 0
252
+ },
253
+ {
254
+ "key": "fact.unit",
255
+ "decision": "PUBLISH",
256
+ "emitted": 0,
257
+ "withheld": 0
258
+ },
259
+ {
260
+ "key": "fact.conditions",
261
+ "decision": "PUBLISH",
262
+ "emitted": 0,
263
+ "withheld": 0
264
+ },
265
+ {
266
+ "key": "fact.locator",
267
+ "decision": "PUBLISH",
268
+ "emitted": 0,
269
+ "withheld": 0
270
+ },
271
+ {
272
+ "key": "fact.provenance",
273
+ "decision": "PUBLISH",
274
+ "emitted": 0,
275
+ "withheld": 0
276
+ },
277
+ {
278
+ "key": "fact.verdict",
279
+ "decision": "PUBLISH",
280
+ "emitted": 0,
281
+ "withheld": 0
282
+ },
283
+ {
284
+ "key": "fact.dependsOn",
285
+ "decision": "PUBLISH",
286
+ "emitted": 0,
287
+ "withheld": 0
288
+ },
289
+ {
290
+ "key": "fact.expression",
291
+ "decision": "PUBLISH",
292
+ "emitted": 0,
293
+ "withheld": 0
294
+ },
295
+ {
296
+ "key": "coverage.coverageId",
297
+ "decision": "PUBLISH",
298
+ "emitted": 0,
299
+ "withheld": 0
300
+ },
301
+ {
302
+ "key": "coverage.domain",
303
+ "decision": "PUBLISH",
304
+ "emitted": 0,
305
+ "withheld": 0
306
+ },
307
+ {
308
+ "key": "coverage.status",
309
+ "decision": "PUBLISH",
310
+ "emitted": 0,
311
+ "withheld": 0
312
+ },
313
+ {
314
+ "key": "coverage.reason",
315
+ "decision": "PUBLISH",
316
+ "emitted": 0,
317
+ "withheld": 0
318
+ },
319
+ {
320
+ "key": "coverage.factIds",
321
+ "decision": "PUBLISH",
322
+ "emitted": 0,
323
+ "withheld": 0
324
+ },
325
+ {
326
+ "key": "coverage.blockingFactIds",
327
+ "decision": "PUBLISH",
328
+ "emitted": 0,
329
+ "withheld": 0
330
+ },
331
+ {
332
+ "key": "interaction.interactionId",
333
+ "decision": "PUBLISH",
334
+ "emitted": 0,
335
+ "withheld": 0
336
+ },
337
+ {
338
+ "key": "interaction.recordIds",
339
+ "decision": "PUBLISH",
340
+ "emitted": 0,
341
+ "withheld": 0
342
+ },
343
+ {
344
+ "key": "interaction.factIds",
345
+ "decision": "PUBLISH",
346
+ "emitted": 0,
347
+ "withheld": 0
348
+ },
349
+ {
350
+ "key": "interaction.conditions",
351
+ "decision": "PUBLISH",
352
+ "emitted": 0,
353
+ "withheld": 0
354
+ },
355
+ {
356
+ "key": "interaction.verdict",
357
+ "decision": "PUBLISH",
358
+ "emitted": 0,
359
+ "withheld": 0
360
+ },
361
+ {
362
+ "key": "integration.ruleId",
363
+ "decision": "PUBLISH",
364
+ "emitted": 0,
365
+ "withheld": 0
366
+ },
367
+ {
368
+ "key": "integration.ownerSkill",
369
+ "decision": "PUBLISH",
370
+ "emitted": 0,
371
+ "withheld": 0
372
+ },
373
+ {
374
+ "key": "integration.domain",
375
+ "decision": "PUBLISH",
376
+ "emitted": 0,
377
+ "withheld": 0
378
+ },
379
+ {
380
+ "key": "integration.recordIds",
381
+ "decision": "PUBLISH",
382
+ "emitted": 0,
383
+ "withheld": 0
384
+ },
385
+ {
386
+ "key": "integration.factIds",
387
+ "decision": "PUBLISH",
388
+ "emitted": 0,
389
+ "withheld": 0
390
+ },
391
+ {
392
+ "key": "integration.conditions",
393
+ "decision": "PUBLISH",
394
+ "emitted": 0,
395
+ "withheld": 0
396
+ },
397
+ {
398
+ "key": "integration.verdict",
399
+ "decision": "PUBLISH",
400
+ "emitted": 0,
401
+ "withheld": 0
402
+ },
403
+ {
404
+ "key": "integration.refusal",
405
+ "decision": "PUBLISH",
406
+ "emitted": 0,
407
+ "withheld": 0
408
+ },
409
+ {
410
+ "key": "integration.calculationId",
411
+ "decision": "PUBLISH",
412
+ "emitted": 0,
413
+ "withheld": 0
414
+ },
415
+ {
416
+ "key": "integration.calculationFactIds",
417
+ "decision": "PUBLISH",
418
+ "emitted": 0,
419
+ "withheld": 0
420
+ },
421
+ {
422
+ "key": "integration.calculationExpression",
423
+ "decision": "PUBLISH",
424
+ "emitted": 0,
425
+ "withheld": 0
426
+ },
427
+ {
428
+ "key": "integration.calculationResultKey",
429
+ "decision": "PUBLISH",
430
+ "emitted": 0,
431
+ "withheld": 0
432
+ },
433
+ {
434
+ "key": "integration.calculationResults",
435
+ "decision": "PUBLISH",
436
+ "emitted": 0,
437
+ "withheld": 0
438
+ },
439
+ {
440
+ "key": "integration.calculationConditions",
441
+ "decision": "PUBLISH",
442
+ "emitted": 0,
443
+ "withheld": 0
444
+ },
445
+ {
446
+ "key": "integration.evidenceChainStage",
447
+ "decision": "PUBLISH",
448
+ "emitted": 0,
449
+ "withheld": 0
450
+ },
451
+ {
452
+ "key": "integration.evidenceChainStatus",
453
+ "decision": "PUBLISH",
454
+ "emitted": 0,
455
+ "withheld": 0
456
+ },
457
+ {
458
+ "key": "integration.evidenceChainFactIds",
459
+ "decision": "PUBLISH",
460
+ "emitted": 0,
461
+ "withheld": 0
462
+ },
463
+ {
464
+ "key": "pinMap.pinMapId",
465
+ "decision": "PUBLISH",
466
+ "emitted": 0,
467
+ "withheld": 0
468
+ },
469
+ {
470
+ "key": "pinMap.symbol",
471
+ "decision": "PUBLISH",
472
+ "emitted": 0,
473
+ "withheld": 0
474
+ },
475
+ {
476
+ "key": "pinMap.footprint",
477
+ "decision": "PUBLISH",
478
+ "emitted": 0,
479
+ "withheld": 0
480
+ },
481
+ {
482
+ "key": "pinMap.pins",
483
+ "decision": "PUBLISH",
484
+ "emitted": 0,
485
+ "withheld": 0
486
+ },
487
+ {
488
+ "key": "pinMap.reviewedBy",
489
+ "decision": "DENY",
490
+ "emitted": 0,
491
+ "withheld": 0
492
+ },
493
+ {
494
+ "key": "reference.document.sourceId",
495
+ "decision": "PUBLISH",
496
+ "emitted": 0,
497
+ "withheld": 0
498
+ },
499
+ {
500
+ "key": "reference.document.documentTitle",
501
+ "decision": "PUBLISH",
502
+ "emitted": 0,
503
+ "withheld": 0
504
+ },
505
+ {
506
+ "key": "reference.document.label",
507
+ "decision": "PUBLISH",
508
+ "emitted": 0,
509
+ "withheld": 0
510
+ },
511
+ {
512
+ "key": "reference.document.authorityClass",
513
+ "decision": "PUBLISH",
514
+ "emitted": 0,
515
+ "withheld": 0
516
+ },
517
+ {
518
+ "key": "reference.document.url",
519
+ "decision": "PUBLISH",
520
+ "emitted": 0,
521
+ "withheld": 0
522
+ },
523
+ {
524
+ "key": "reference.document.availability",
525
+ "decision": "PUBLISH",
526
+ "emitted": 0,
527
+ "withheld": 0
528
+ },
529
+ {
530
+ "key": "reference.document.documentKind",
531
+ "decision": "PUBLISH",
532
+ "emitted": 0,
533
+ "withheld": 0
534
+ },
535
+ {
536
+ "key": "reference.footprint.packageId",
537
+ "decision": "PUBLISH",
538
+ "emitted": 0,
539
+ "withheld": 0
540
+ },
541
+ {
542
+ "key": "reference.footprint.name",
543
+ "decision": "PUBLISH",
544
+ "emitted": 0,
545
+ "withheld": 0
546
+ },
547
+ {
548
+ "key": "reference.footprint.path",
549
+ "decision": "PUBLISH",
550
+ "emitted": 0,
551
+ "withheld": 0
552
+ },
553
+ {
554
+ "key": "reference.model.path",
555
+ "decision": "PUBLISH",
556
+ "emitted": 0,
557
+ "withheld": 0
558
+ },
559
+ {
560
+ "key": "reference.model.offset",
561
+ "decision": "PUBLISH",
562
+ "emitted": 0,
563
+ "withheld": 0
564
+ },
565
+ {
566
+ "key": "reference.model.rotation",
567
+ "decision": "PUBLISH",
568
+ "emitted": 0,
569
+ "withheld": 0
570
+ },
571
+ {
572
+ "key": "reference.model.scale",
573
+ "decision": "PUBLISH",
574
+ "emitted": 0,
575
+ "withheld": 0
576
+ },
577
+ {
578
+ "key": "reference.package.recordIds",
579
+ "decision": "PUBLISH",
580
+ "emitted": 0,
581
+ "withheld": 0
582
+ },
583
+ {
584
+ "key": "corpus.counts",
585
+ "decision": "PUBLISH",
586
+ "emitted": 1,
587
+ "withheld": 0
588
+ },
589
+ {
590
+ "key": "asset.datasheetPdf",
591
+ "decision": "PUBLISH",
592
+ "emitted": 0,
593
+ "withheld": 0
594
+ },
595
+ {
596
+ "key": "asset.footprintPreview",
597
+ "decision": "PUBLISH",
598
+ "emitted": 0,
599
+ "withheld": 0
600
+ },
601
+ {
602
+ "key": "asset.modelPreview",
603
+ "decision": "PUBLISH",
604
+ "emitted": 0,
605
+ "withheld": 0
606
+ },
607
+ {
608
+ "key": "asset.binary",
609
+ "decision": "DENY",
610
+ "emitted": 0,
611
+ "withheld": 0
612
+ }
613
+ ],
614
+ "urls": [],
615
+ "counts": {
616
+ "generatedPages": 4,
617
+ "publishedCoverageDomains": 0,
618
+ "publishedFacts": 0,
619
+ "publishedIntegrationRules": 0,
620
+ "publishedInteractions": 0,
621
+ "publishedPinMaps": 0,
622
+ "publishedRecords": 0,
623
+ "publishedSources": 0
624
+ }
625
+ }
@@ -0,0 +1,9 @@
1
+ {
2
+ "schema_version": 1,
3
+ "assets": [
4
+ {
5
+ "path": "favicon.svg",
6
+ "reason": "Site favicon shipped by the zudo-doc scaffold; not component evidence or CAD."
7
+ }
8
+ ]
9
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "schema_version": 1,
3
+ "recordIds": [],
4
+ "sourceIds": [],
5
+ "linkableSourceIds": [],
6
+ "documentSelections": [],
7
+ "expect": {
8
+ "records": 0,
9
+ "sources": 0,
10
+ "integrationRules": 0,
11
+ "packages": 0
12
+ }
13
+ }
@@ -0,0 +1,33 @@
1
+ # Authoring templates
2
+
3
+ These templates are **not published**. Copy one into the documentation tree when the activity it describes actually happens; do not publish empty copies to fill the navigation.
4
+
5
+ ## Project documentation templates
6
+
7
+ The `project-docs/` tree mirrors the site's sections. To use a template, copy it to the same relative path under `doc/src/content/docs/`, give the copy a topic-specific filename, `title`, `description` and `sidebar_position`, and replace the "Not entered" prompts as facts become known. Links inside a template point at the sibling template locations; after copying, keep a link only if its target page exists in the site.
8
+
9
+ | Template | Use it when | What to enter |
10
+ | --- | --- | --- |
11
+ | [project/index.mdx](./project-docs/project/index.mdx) | The brief must be rebuilt from scratch (the live brief is already published at `project/index.mdx`) | Purpose, user behavior, constraints, current design revision |
12
+ | [project/next-actions.mdx](./project-docs/project/next-actions.mdx) | Resetting the handoff page (the live page is already published) | Current open questions, the next bounded task, blocked work |
13
+ | [project/task-request.mdx](./project-docs/project/task-request.mdx) | Delegating a bounded research or implementation task to an agent | Goal, scope, references, outputs and a definition of done |
14
+ | [project/change-impact.mdx](./project-docs/project/change-impact.mdx) | Before applying a change with downstream effects (Workflow G) | Affected components, interfaces, generated assets and tests |
15
+ | [architecture/overview.mdx](./project-docs/architecture/overview.mdx) | Resetting the architecture overview (the live page is already published) | Functional blocks, operating states, unconfirmed boundaries |
16
+ | [architecture/interfaces.mdx](./project-docs/architecture/interfaces.mdx) | Once blocks or connectors are proposed | Power, signal, mechanical and programming boundaries |
17
+ | [research/component-candidate.mdx](./project-docs/research/component-candidate.mdx) | Comparing or researching a component (Workflow A) | Research question, criteria, linked evidence, missing proof |
18
+ | [decisions/decision.mdx](./project-docs/decisions/decision.mdx) | Making a consequential choice | Alternatives, chosen direction, tradeoffs, evidence and conditions |
19
+ | [decisions/sourcing.mdx](./project-docs/decisions/sourcing.mdx) | Assembly or procurement becomes relevant | Population policy, cost reasoning, dated sourcing observations |
20
+ | [verification/bring-up.mdx](./project-docs/verification/bring-up.mdx) | Planning or recording one verification run (Workflow F) | Revision, setup, planned checks, results and limits |
21
+
22
+ For repeated records, duplicate the relevant template with a topic-specific filename. A decision ID identifies a decision across edits; a verification report identifies one execution against one revision, so never overwrite a failed run with a later successful one.
23
+
24
+ These pages explain intent, rationale and decisions. Exact component identity, sources, facts, pin maps and coverage belong to the owner evidence bundles under `.claude/skills/component-*/`; the component pages under `/docs/components/` are generated from them. Do not maintain a second rating table, pin table or catalog by hand. When an argument needs a number, cite the canonical fact ID and keep its qualifier and conditions.
25
+
26
+ ## CAD asset receipt
27
+
28
+ | Template | Use it when |
29
+ | --- | --- |
30
+ | [cad-asset-receipt.json](./cad-asset-receipt.json) | Recording an acquired symbol, footprint or 3D model (Workflow D); save the copy as `circuit/cad-receipts/ASSET_ID.receipt.json` |
31
+ | [cad-asset-receipt.md](./cad-asset-receipt.md) | Explains every receipt field and the fidelity classes; copy it beside the JSON only when a longer explanation is needed |
32
+
33
+ See [WORKFLOW.md](../WORKFLOW.md) for the workflows that use each template and [agent-task-examples.md](../agent-task-examples.md) for short requests that lead to them.