@x12i/docify 1.0.0 → 1.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.
- package/bin/docify.js +0 -0
- package/dist/cli.js +430 -33
- package/dist/cli.js.map +1 -1
- package/dist/generated/bundle.d.ts +708 -0
- package/dist/generated/bundle.d.ts.map +1 -1
- package/dist/generated/bundle.js +1184 -14
- package/dist/generated/bundle.js.map +1 -1
- package/dist/index.d.ts +7 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -5
- package/dist/index.js.map +1 -1
- package/package.json +5 -16
|
@@ -90,6 +90,18 @@ export declare const catalog: {
|
|
|
90
90
|
readonly tags: readonly ["design", "theme", "brand"];
|
|
91
91
|
readonly color: "#16324f";
|
|
92
92
|
readonly dir: "05-design";
|
|
93
|
+
}, {
|
|
94
|
+
readonly id: "06-getting-started-and-tutorials";
|
|
95
|
+
readonly familyId: "docify";
|
|
96
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
97
|
+
readonly status: "available";
|
|
98
|
+
readonly kicker: "CASE FILE · DOC-06";
|
|
99
|
+
readonly title: "Getting Started & Tutorials";
|
|
100
|
+
readonly subtitle: "Install, run, author, publish";
|
|
101
|
+
readonly blurb: "Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.";
|
|
102
|
+
readonly tags: readonly ["getting-started", "tutorials", "install", "start-here"];
|
|
103
|
+
readonly color: "#1f6e5c";
|
|
104
|
+
readonly dir: "06-getting-started-and-tutorials";
|
|
93
105
|
}];
|
|
94
106
|
};
|
|
95
107
|
export declare const useCases: {
|
|
@@ -105,6 +117,12 @@ export declare const useCases: {
|
|
|
105
117
|
readonly chapters: readonly ["the-central-idea", "1-what-x12i-docify-is", "2-layers", "4-where-to-go-next"];
|
|
106
118
|
}];
|
|
107
119
|
readonly alsoSee: readonly ["00-platform-overview"];
|
|
120
|
+
readonly prerequisites: readonly [];
|
|
121
|
+
readonly successCriteria: readonly [];
|
|
122
|
+
readonly nextUseCases: readonly [];
|
|
123
|
+
readonly scenarioIds: readonly [];
|
|
124
|
+
readonly guideIds: readonly [];
|
|
125
|
+
readonly troubleshooting: readonly [];
|
|
108
126
|
}, {
|
|
109
127
|
readonly id: "map-packages";
|
|
110
128
|
readonly title: "Map the @x12i/docify-* packages";
|
|
@@ -117,6 +135,12 @@ export declare const useCases: {
|
|
|
117
135
|
readonly chapters: readonly ["1-package-table", "2-dependency-shape", "3-publish-and-install"];
|
|
118
136
|
}];
|
|
119
137
|
readonly alsoSee: readonly ["01-packages"];
|
|
138
|
+
readonly prerequisites: readonly [];
|
|
139
|
+
readonly successCriteria: readonly [];
|
|
140
|
+
readonly nextUseCases: readonly [];
|
|
141
|
+
readonly scenarioIds: readonly [];
|
|
142
|
+
readonly guideIds: readonly [];
|
|
143
|
+
readonly troubleshooting: readonly [];
|
|
120
144
|
}, {
|
|
121
145
|
readonly id: "wire-product-library";
|
|
122
146
|
readonly title: "Wire a product docs library";
|
|
@@ -129,6 +153,12 @@ export declare const useCases: {
|
|
|
129
153
|
readonly chapters: readonly ["1-recipe", "2-content-layout", "3-data-contracts", "4-build-pipeline"];
|
|
130
154
|
}];
|
|
131
155
|
readonly alsoSee: readonly ["02-authoring", "05-design"];
|
|
156
|
+
readonly prerequisites: readonly [];
|
|
157
|
+
readonly successCriteria: readonly [];
|
|
158
|
+
readonly nextUseCases: readonly [];
|
|
159
|
+
readonly scenarioIds: readonly [];
|
|
160
|
+
readonly guideIds: readonly [];
|
|
161
|
+
readonly troubleshooting: readonly [];
|
|
132
162
|
}, {
|
|
133
163
|
readonly id: "ship-human-site";
|
|
134
164
|
readonly title: "Ship the human web app";
|
|
@@ -141,6 +171,12 @@ export declare const useCases: {
|
|
|
141
171
|
readonly chapters: readonly ["1-best-form-for-humans", "2-typical-flow", "3-what-the-bundle-emits"];
|
|
142
172
|
}];
|
|
143
173
|
readonly alsoSee: readonly ["03-for-humans"];
|
|
174
|
+
readonly prerequisites: readonly [];
|
|
175
|
+
readonly successCriteria: readonly [];
|
|
176
|
+
readonly nextUseCases: readonly [];
|
|
177
|
+
readonly scenarioIds: readonly [];
|
|
178
|
+
readonly guideIds: readonly [];
|
|
179
|
+
readonly troubleshooting: readonly [];
|
|
144
180
|
}, {
|
|
145
181
|
readonly id: "ship-agent-packs";
|
|
146
182
|
readonly title: "Ship agent markdown and knowledge SDK";
|
|
@@ -153,6 +189,12 @@ export declare const useCases: {
|
|
|
153
189
|
readonly chapters: readonly ["1-best-form-for-agents", "2-discovery", "3-knowledge-sdk", "4-install-contract"];
|
|
154
190
|
}];
|
|
155
191
|
readonly alsoSee: readonly ["04-for-agents"];
|
|
192
|
+
readonly prerequisites: readonly [];
|
|
193
|
+
readonly successCriteria: readonly [];
|
|
194
|
+
readonly nextUseCases: readonly [];
|
|
195
|
+
readonly scenarioIds: readonly [];
|
|
196
|
+
readonly guideIds: readonly [];
|
|
197
|
+
readonly troubleshooting: readonly [];
|
|
156
198
|
}, {
|
|
157
199
|
readonly id: "keep-one-design";
|
|
158
200
|
readonly title: "Keep one design system";
|
|
@@ -165,6 +207,12 @@ export declare const useCases: {
|
|
|
165
207
|
readonly chapters: readonly ["1-principle", "2-identity", "3-surfaces", "4-do-not"];
|
|
166
208
|
}];
|
|
167
209
|
readonly alsoSee: readonly ["05-design"];
|
|
210
|
+
readonly prerequisites: readonly [];
|
|
211
|
+
readonly successCriteria: readonly [];
|
|
212
|
+
readonly nextUseCases: readonly [];
|
|
213
|
+
readonly scenarioIds: readonly [];
|
|
214
|
+
readonly guideIds: readonly [];
|
|
215
|
+
readonly troubleshooting: readonly [];
|
|
168
216
|
}];
|
|
169
217
|
};
|
|
170
218
|
export declare const site: {
|
|
@@ -180,6 +228,12 @@ export declare const site: {
|
|
|
180
228
|
readonly nav: readonly [{
|
|
181
229
|
readonly label: "Getting started";
|
|
182
230
|
readonly href: "/getting-started";
|
|
231
|
+
}, {
|
|
232
|
+
readonly label: "Journey";
|
|
233
|
+
readonly href: "/journey";
|
|
234
|
+
}, {
|
|
235
|
+
readonly label: "Search";
|
|
236
|
+
readonly href: "/search";
|
|
183
237
|
}, {
|
|
184
238
|
readonly label: "Use cases";
|
|
185
239
|
readonly href: "/use-cases";
|
|
@@ -193,6 +247,21 @@ export declare const site: {
|
|
|
193
247
|
}, {
|
|
194
248
|
readonly label: "Getting started";
|
|
195
249
|
readonly href: "/getting-started";
|
|
250
|
+
}, {
|
|
251
|
+
readonly label: "Journey";
|
|
252
|
+
readonly href: "/journey";
|
|
253
|
+
}, {
|
|
254
|
+
readonly label: "Search";
|
|
255
|
+
readonly href: "/search";
|
|
256
|
+
}, {
|
|
257
|
+
readonly label: "Explore";
|
|
258
|
+
readonly href: "/explore";
|
|
259
|
+
}, {
|
|
260
|
+
readonly label: "Concepts";
|
|
261
|
+
readonly href: "/concepts";
|
|
262
|
+
}, {
|
|
263
|
+
readonly label: "Guides";
|
|
264
|
+
readonly href: "/guides";
|
|
196
265
|
}, {
|
|
197
266
|
readonly label: "Use cases";
|
|
198
267
|
readonly href: "/use-cases";
|
|
@@ -297,6 +366,21 @@ export declare const manifest: {
|
|
|
297
366
|
readonly developers: "downloads/books/05-design/developers.chapters.json";
|
|
298
367
|
readonly builders: "downloads/books/05-design/builders.chapters.json";
|
|
299
368
|
};
|
|
369
|
+
}, {
|
|
370
|
+
readonly id: "06-getting-started-and-tutorials";
|
|
371
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
372
|
+
readonly md: {
|
|
373
|
+
readonly developers: "downloads/books/06-getting-started-and-tutorials/developers.md";
|
|
374
|
+
readonly builders: "downloads/books/06-getting-started-and-tutorials/builders.md";
|
|
375
|
+
};
|
|
376
|
+
readonly pdf: {
|
|
377
|
+
readonly developers: null;
|
|
378
|
+
readonly builders: null;
|
|
379
|
+
};
|
|
380
|
+
readonly chapters: {
|
|
381
|
+
readonly developers: "downloads/books/06-getting-started-and-tutorials/developers.chapters.json";
|
|
382
|
+
readonly builders: "downloads/books/06-getting-started-and-tutorials/builders.chapters.json";
|
|
383
|
+
};
|
|
300
384
|
}];
|
|
301
385
|
readonly useCases: readonly [{
|
|
302
386
|
readonly id: "orient-docify";
|
|
@@ -353,6 +437,630 @@ export declare const manifest: {
|
|
|
353
437
|
readonly chapters: readonly ["1-principle", "2-identity", "3-surfaces", "4-do-not"];
|
|
354
438
|
}];
|
|
355
439
|
}];
|
|
440
|
+
readonly indexes: {
|
|
441
|
+
readonly indexMd: "INDEX.md";
|
|
442
|
+
readonly searchJson: "SEARCH.json";
|
|
443
|
+
};
|
|
444
|
+
readonly concepts: readonly [{
|
|
445
|
+
readonly id: "explicit-authoring";
|
|
446
|
+
readonly title: "Explicit authoring";
|
|
447
|
+
readonly md: "concepts/explicit-authoring.md";
|
|
448
|
+
}, {
|
|
449
|
+
readonly id: "open-markdown";
|
|
450
|
+
readonly title: "Open Markdown baseline";
|
|
451
|
+
readonly md: "concepts/open-markdown.md";
|
|
452
|
+
}, {
|
|
453
|
+
readonly id: "guide-vs-scenario";
|
|
454
|
+
readonly title: "Guides vs scenarios vs journeys";
|
|
455
|
+
readonly md: "concepts/guide-vs-scenario.md";
|
|
456
|
+
}];
|
|
457
|
+
readonly guides: readonly [{
|
|
458
|
+
readonly id: "scaffold-concept";
|
|
459
|
+
readonly title: "Scaffold a concept page";
|
|
460
|
+
readonly md: "guides/scaffold-concept.md";
|
|
461
|
+
}];
|
|
462
|
+
readonly scenarios: readonly [{
|
|
463
|
+
readonly id: "choose-content-type";
|
|
464
|
+
readonly title: "Choose the right Docify content type";
|
|
465
|
+
readonly md: "scenarios/choose-content-type.md";
|
|
466
|
+
}];
|
|
467
|
+
readonly decisions: readonly [];
|
|
468
|
+
readonly glossary: readonly [{
|
|
469
|
+
readonly id: "docify";
|
|
470
|
+
readonly term: "Docify";
|
|
471
|
+
readonly md: "glossary/docify.md";
|
|
472
|
+
}, {
|
|
473
|
+
readonly id: "search-json";
|
|
474
|
+
readonly term: "SEARCH.json";
|
|
475
|
+
readonly md: "glossary/search-json.md";
|
|
476
|
+
}];
|
|
477
|
+
readonly visuals: readonly [];
|
|
478
|
+
readonly diagrams: readonly [{
|
|
479
|
+
readonly id: "docify-dual-audience";
|
|
480
|
+
readonly title: "One library, two consumption surfaces";
|
|
481
|
+
readonly md: "diagrams/docify-dual-audience.md";
|
|
482
|
+
readonly source: "diagrams/sources/docify-dual-audience.mmd";
|
|
483
|
+
}];
|
|
484
|
+
readonly relationships: readonly [{
|
|
485
|
+
readonly id: "explicit-to-open-md";
|
|
486
|
+
readonly type: "prerequisiteOf";
|
|
487
|
+
readonly from: "explicit-authoring";
|
|
488
|
+
readonly to: "open-markdown";
|
|
489
|
+
}, {
|
|
490
|
+
readonly id: "types-related";
|
|
491
|
+
readonly type: "relatedTo";
|
|
492
|
+
readonly from: "guide-vs-scenario";
|
|
493
|
+
readonly to: "explicit-authoring";
|
|
494
|
+
}];
|
|
495
|
+
readonly tutorials: readonly [];
|
|
496
|
+
readonly examples: readonly [];
|
|
497
|
+
readonly sampleData: readonly [];
|
|
498
|
+
readonly uiClients: readonly [];
|
|
499
|
+
readonly apis: readonly [];
|
|
500
|
+
readonly packs: readonly [{
|
|
501
|
+
readonly id: "concept/explicit-authoring";
|
|
502
|
+
readonly type: "concept";
|
|
503
|
+
readonly path: "packs/concept/explicit-authoring";
|
|
504
|
+
}, {
|
|
505
|
+
readonly id: "concept/open-markdown";
|
|
506
|
+
readonly type: "concept";
|
|
507
|
+
readonly path: "packs/concept/open-markdown";
|
|
508
|
+
}, {
|
|
509
|
+
readonly id: "concept/guide-vs-scenario";
|
|
510
|
+
readonly type: "concept";
|
|
511
|
+
readonly path: "packs/concept/guide-vs-scenario";
|
|
512
|
+
}, {
|
|
513
|
+
readonly id: "guide/scaffold-concept";
|
|
514
|
+
readonly type: "guide";
|
|
515
|
+
readonly path: "packs/guide/scaffold-concept";
|
|
516
|
+
}, {
|
|
517
|
+
readonly id: "scenario/choose-content-type";
|
|
518
|
+
readonly type: "scenario";
|
|
519
|
+
readonly path: "packs/scenario/choose-content-type";
|
|
520
|
+
}];
|
|
521
|
+
};
|
|
522
|
+
export declare const knowledge: {
|
|
523
|
+
readonly concepts: readonly [{
|
|
524
|
+
readonly summary: "Docify only builds knowledge that authors declare — it never discovers product truth from source.";
|
|
525
|
+
readonly problem: "Auto-scanning repositories invents incomplete or wrong documentation.";
|
|
526
|
+
readonly why: "Accessibility requires intentional explanations, relationships, and confirmation boundaries.";
|
|
527
|
+
readonly mentalModel: "Authors understand; Docify packages and presents.";
|
|
528
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
529
|
+
readonly whenItMatters: readonly ["Starting a docs library", "Asking an agent to document a product"];
|
|
530
|
+
readonly whenNotToUse: readonly [];
|
|
531
|
+
readonly prerequisites: readonly [];
|
|
532
|
+
readonly related: readonly ["open-markdown", "knowledge-relationships"];
|
|
533
|
+
readonly next: readonly ["open-markdown"];
|
|
534
|
+
readonly exampleIds: readonly [];
|
|
535
|
+
readonly commonMistakes: readonly [];
|
|
536
|
+
readonly successCriteria: readonly [];
|
|
537
|
+
readonly invariants: readonly [];
|
|
538
|
+
readonly alternatives: readonly [];
|
|
539
|
+
readonly tags: readonly ["authoring", "boundary"];
|
|
540
|
+
readonly id: "explicit-authoring";
|
|
541
|
+
readonly type: "concept";
|
|
542
|
+
readonly title: "Explicit authoring";
|
|
543
|
+
readonly visualIds: readonly [];
|
|
544
|
+
readonly diagramIds: readonly [];
|
|
545
|
+
readonly referenceIds: readonly [];
|
|
546
|
+
}, {
|
|
547
|
+
readonly summary: "Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.";
|
|
548
|
+
readonly problem: "Knowledge trapped in generated JS or HTML blocks offline and agent workflows.";
|
|
549
|
+
readonly why: "Agents and humans must grep, read, and pack the same facts without executing code.";
|
|
550
|
+
readonly mentalModel: "INDEX.md and SEARCH.json are the door; Markdown files are the rooms.";
|
|
551
|
+
readonly audiences: readonly ["developers"];
|
|
552
|
+
readonly whenItMatters: readonly [];
|
|
553
|
+
readonly whenNotToUse: readonly [];
|
|
554
|
+
readonly prerequisites: readonly [];
|
|
555
|
+
readonly related: readonly ["explicit-authoring"];
|
|
556
|
+
readonly next: readonly ["guide-vs-scenario"];
|
|
557
|
+
readonly exampleIds: readonly [];
|
|
558
|
+
readonly commonMistakes: readonly [];
|
|
559
|
+
readonly successCriteria: readonly [];
|
|
560
|
+
readonly invariants: readonly [];
|
|
561
|
+
readonly alternatives: readonly [];
|
|
562
|
+
readonly tags: readonly ["agents", "packaging"];
|
|
563
|
+
readonly id: "open-markdown";
|
|
564
|
+
readonly type: "concept";
|
|
565
|
+
readonly title: "Open Markdown baseline";
|
|
566
|
+
readonly visualIds: readonly [];
|
|
567
|
+
readonly diagramIds: readonly [];
|
|
568
|
+
readonly referenceIds: readonly [];
|
|
569
|
+
}, {
|
|
570
|
+
readonly summary: "Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.";
|
|
571
|
+
readonly problem: "Mixing learning, diagnosis, and production procedures confuses agents and operators.";
|
|
572
|
+
readonly why: "Clear types keep invariants and confirmation boundaries enforceable.";
|
|
573
|
+
readonly mentalModel: "Scenario chooses a guide; journey sequences several guides and decisions.";
|
|
574
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
575
|
+
readonly whenItMatters: readonly [];
|
|
576
|
+
readonly whenNotToUse: readonly [];
|
|
577
|
+
readonly prerequisites: readonly [];
|
|
578
|
+
readonly related: readonly ["explicit-authoring"];
|
|
579
|
+
readonly next: readonly [];
|
|
580
|
+
readonly exampleIds: readonly [];
|
|
581
|
+
readonly commonMistakes: readonly [];
|
|
582
|
+
readonly successCriteria: readonly [];
|
|
583
|
+
readonly invariants: readonly [];
|
|
584
|
+
readonly alternatives: readonly [];
|
|
585
|
+
readonly tags: readonly ["authoring"];
|
|
586
|
+
readonly id: "guide-vs-scenario";
|
|
587
|
+
readonly type: "concept";
|
|
588
|
+
readonly title: "Guides vs scenarios vs journeys";
|
|
589
|
+
readonly visualIds: readonly [];
|
|
590
|
+
readonly diagramIds: readonly [];
|
|
591
|
+
readonly referenceIds: readonly [];
|
|
592
|
+
}];
|
|
593
|
+
readonly guides: readonly [{
|
|
594
|
+
readonly summary: "Create a validated concept with problem, why, and mental model.";
|
|
595
|
+
readonly why: "Concepts without why become unusable glossary stubs.";
|
|
596
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
597
|
+
readonly whenItMatters: readonly [];
|
|
598
|
+
readonly whenNotToUse: readonly [];
|
|
599
|
+
readonly prerequisites: readonly [];
|
|
600
|
+
readonly related: readonly ["explicit-authoring"];
|
|
601
|
+
readonly next: readonly [];
|
|
602
|
+
readonly exampleIds: readonly [];
|
|
603
|
+
readonly commonMistakes: readonly [];
|
|
604
|
+
readonly successCriteria: readonly [];
|
|
605
|
+
readonly invariants: readonly ["Docify does not invent the concept from source code"];
|
|
606
|
+
readonly alternatives: readonly [];
|
|
607
|
+
readonly confirmationRequired: false;
|
|
608
|
+
readonly tags: readonly ["authoring"];
|
|
609
|
+
readonly id: "scaffold-concept";
|
|
610
|
+
readonly type: "guide";
|
|
611
|
+
readonly title: "Scaffold a concept page";
|
|
612
|
+
readonly useWhen: readonly ["Documenting a product idea that needs explanation first"];
|
|
613
|
+
readonly doNotUseWhen: readonly ["Writing a step-by-step production procedure (use a guide)"];
|
|
614
|
+
readonly inputs: readonly [];
|
|
615
|
+
readonly permissions: readonly [];
|
|
616
|
+
readonly steps: readonly [{
|
|
617
|
+
readonly id: "scaffold";
|
|
618
|
+
readonly title: "Run docify scaffold concept <id>";
|
|
619
|
+
readonly expectedResult: "Markdown file under concepts/";
|
|
620
|
+
readonly optional: false;
|
|
621
|
+
}, {
|
|
622
|
+
readonly id: "fill";
|
|
623
|
+
readonly title: "Fill summary, problem, why, mental model";
|
|
624
|
+
readonly expectedResult: "Human-understanding fields present";
|
|
625
|
+
readonly optional: false;
|
|
626
|
+
}, {
|
|
627
|
+
readonly id: "validate";
|
|
628
|
+
readonly title: "Run docify validate";
|
|
629
|
+
readonly expectedResult: "Validation passes";
|
|
630
|
+
readonly optional: false;
|
|
631
|
+
}];
|
|
632
|
+
readonly verification: readonly ["Concept appears in INDEX.md after build"];
|
|
633
|
+
readonly recovery: readonly [];
|
|
634
|
+
readonly tutorialIds: readonly [];
|
|
635
|
+
readonly referenceIds: readonly [];
|
|
636
|
+
readonly scenarioIds: readonly [];
|
|
637
|
+
}];
|
|
638
|
+
readonly scenarios: readonly [{
|
|
639
|
+
readonly summary: "Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.";
|
|
640
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
641
|
+
readonly whenItMatters: readonly [];
|
|
642
|
+
readonly whenNotToUse: readonly [];
|
|
643
|
+
readonly prerequisites: readonly [];
|
|
644
|
+
readonly related: readonly [];
|
|
645
|
+
readonly next: readonly [];
|
|
646
|
+
readonly exampleIds: readonly [];
|
|
647
|
+
readonly commonMistakes: readonly [];
|
|
648
|
+
readonly successCriteria: readonly [];
|
|
649
|
+
readonly invariants: readonly ["Do not invent unsupported actions from a broad why statement"];
|
|
650
|
+
readonly alternatives: readonly [];
|
|
651
|
+
readonly tags: readonly [];
|
|
652
|
+
readonly id: "choose-content-type";
|
|
653
|
+
readonly type: "scenario";
|
|
654
|
+
readonly title: "Choose the right Docify content type";
|
|
655
|
+
readonly situation: "An agent is asked to document a product behavior and is unsure which file to create.";
|
|
656
|
+
readonly preconditions: readonly ["Product material is explicitly supplied"];
|
|
657
|
+
readonly signals: readonly ["Need a definition and why", "Need a bounded production procedure", "Need branching on observed state", "Need safe rehearsal with sample data"];
|
|
658
|
+
readonly decisionQuestion: "Which Docify content type fits this goal?";
|
|
659
|
+
readonly paths: readonly [{
|
|
660
|
+
readonly id: "concept";
|
|
661
|
+
readonly label: "Author a concept";
|
|
662
|
+
readonly when: "The reader needs what it is and why it exists";
|
|
663
|
+
readonly rationale: "Concepts carry mental models before procedures.";
|
|
664
|
+
readonly guideIds: readonly ["scaffold-concept"];
|
|
665
|
+
}, {
|
|
666
|
+
readonly id: "guide";
|
|
667
|
+
readonly label: "Author a guide";
|
|
668
|
+
readonly when: "The reader needs a bounded task with verification";
|
|
669
|
+
readonly rationale: "Guides are normative procedures with confirmation boundaries.";
|
|
670
|
+
readonly guideIds: readonly ["scaffold-concept"];
|
|
671
|
+
}, {
|
|
672
|
+
readonly id: "tutorial";
|
|
673
|
+
readonly label: "Author a tutorial";
|
|
674
|
+
readonly when: "The goal is learning with sample data and reset";
|
|
675
|
+
readonly rationale: "Tutorials teach; production guides remain usable without them.";
|
|
676
|
+
readonly guideIds: readonly [];
|
|
677
|
+
}];
|
|
678
|
+
readonly verification: readonly ["Selected type matches the FR selection table"];
|
|
679
|
+
readonly recovery: readonly [];
|
|
680
|
+
readonly escalation: "If product truth is unclear, stop and ask the product owners — do not infer from source.";
|
|
681
|
+
}];
|
|
682
|
+
readonly decisions: readonly [];
|
|
683
|
+
readonly glossary: readonly [{
|
|
684
|
+
readonly id: "docify";
|
|
685
|
+
readonly term: "Docify";
|
|
686
|
+
readonly meaning: "x12i framework that turns explicitly authored product knowledge into a website and agent package.";
|
|
687
|
+
readonly technicalName: "@x12i/docify";
|
|
688
|
+
readonly aliases: readonly ["x12i-docify"];
|
|
689
|
+
readonly relatedConceptIds: readonly ["explicit-authoring"];
|
|
690
|
+
readonly firstPageId: "explicit-authoring";
|
|
691
|
+
}, {
|
|
692
|
+
readonly id: "search-json";
|
|
693
|
+
readonly term: "SEARCH.json";
|
|
694
|
+
readonly meaning: "Deterministic local search index over all addressable knowledge items.";
|
|
695
|
+
readonly aliases: readonly ["search index"];
|
|
696
|
+
readonly relatedConceptIds: readonly ["open-markdown"];
|
|
697
|
+
}];
|
|
698
|
+
readonly visuals: readonly [];
|
|
699
|
+
readonly diagrams: readonly [{
|
|
700
|
+
readonly id: "docify-dual-audience";
|
|
701
|
+
readonly type: "flow";
|
|
702
|
+
readonly title: "One library, two consumption surfaces";
|
|
703
|
+
readonly summary: "Explicitly authored content becomes a human website and an agent knowledge package.";
|
|
704
|
+
readonly why: "Humans and agents share one source model without forked facts.";
|
|
705
|
+
readonly direction: "left-to-right";
|
|
706
|
+
readonly nodes: readonly [{
|
|
707
|
+
readonly id: "authors";
|
|
708
|
+
readonly label: "Authors";
|
|
709
|
+
readonly description: "Humans or agents write explicit knowledge";
|
|
710
|
+
readonly conceptId: "explicit-authoring";
|
|
711
|
+
}, {
|
|
712
|
+
readonly id: "validate";
|
|
713
|
+
readonly label: "Validate";
|
|
714
|
+
readonly description: "Schemas, links, a11y metadata";
|
|
715
|
+
}, {
|
|
716
|
+
readonly id: "web";
|
|
717
|
+
readonly label: "Website";
|
|
718
|
+
readonly description: "Human consumption";
|
|
719
|
+
}, {
|
|
720
|
+
readonly id: "agent";
|
|
721
|
+
readonly label: "Agent package";
|
|
722
|
+
readonly description: "INDEX, SEARCH, Markdown, SDK";
|
|
723
|
+
readonly conceptId: "open-markdown";
|
|
724
|
+
}];
|
|
725
|
+
readonly edges: readonly [{
|
|
726
|
+
readonly from: "authors";
|
|
727
|
+
readonly to: "validate";
|
|
728
|
+
readonly label: "declare";
|
|
729
|
+
readonly description: "Only declared inputs are processed";
|
|
730
|
+
}, {
|
|
731
|
+
readonly from: "validate";
|
|
732
|
+
readonly to: "web";
|
|
733
|
+
readonly label: "render";
|
|
734
|
+
}, {
|
|
735
|
+
readonly from: "validate";
|
|
736
|
+
readonly to: "agent";
|
|
737
|
+
readonly label: "pack";
|
|
738
|
+
}];
|
|
739
|
+
readonly howToRead: "Follow arrows from authored sources to human and agent outputs.";
|
|
740
|
+
readonly keyTakeaways: readonly ["Authors own product truth", "Docify never scans the product repository", "Open Markdown is the agent baseline"];
|
|
741
|
+
readonly textAlternative: "Authors write books, concepts, guides, diagrams, and data files. Docify validates and builds a website for humans and Markdown indexes, packs, and an SDK for agents.";
|
|
742
|
+
readonly mermaid: "flowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n";
|
|
743
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
744
|
+
readonly related: readonly ["explicit-authoring", "open-markdown"];
|
|
745
|
+
readonly tags: readonly ["platform"];
|
|
746
|
+
}];
|
|
747
|
+
readonly relationships: readonly [{
|
|
748
|
+
readonly id: "explicit-to-open-md";
|
|
749
|
+
readonly type: "prerequisiteOf";
|
|
750
|
+
readonly from: "explicit-authoring";
|
|
751
|
+
readonly to: "open-markdown";
|
|
752
|
+
readonly label: "enables";
|
|
753
|
+
readonly description: "Explicit authorship feeds open Markdown packaging";
|
|
754
|
+
}, {
|
|
755
|
+
readonly id: "types-related";
|
|
756
|
+
readonly type: "relatedTo";
|
|
757
|
+
readonly from: "guide-vs-scenario";
|
|
758
|
+
readonly to: "explicit-authoring";
|
|
759
|
+
readonly description: "Type selection is part of the authoring method";
|
|
760
|
+
}];
|
|
761
|
+
readonly tutorials: readonly [];
|
|
762
|
+
readonly examples: readonly [];
|
|
763
|
+
readonly sampleData: readonly [];
|
|
764
|
+
readonly uiClients: readonly [];
|
|
765
|
+
readonly apis: readonly [];
|
|
766
|
+
};
|
|
767
|
+
export declare const search: {
|
|
768
|
+
readonly version: 1;
|
|
769
|
+
readonly product: "docify";
|
|
770
|
+
readonly generatedAt: "2026-07-26T10:51:47.660Z";
|
|
771
|
+
readonly records: readonly [{
|
|
772
|
+
readonly id: "explicit-authoring";
|
|
773
|
+
readonly type: "concept";
|
|
774
|
+
readonly title: "Explicit authoring";
|
|
775
|
+
readonly summary: "Docify only builds knowledge that authors declare — it never discovers product truth from source.";
|
|
776
|
+
readonly aliases: readonly [];
|
|
777
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
778
|
+
readonly tags: readonly ["authoring", "boundary"];
|
|
779
|
+
readonly goals: readonly [];
|
|
780
|
+
readonly path: "concepts/explicit-authoring.md";
|
|
781
|
+
readonly webPath: "/concepts/explicit-authoring";
|
|
782
|
+
readonly prerequisites: readonly [];
|
|
783
|
+
readonly related: readonly ["open-markdown", "knowledge-relationships"];
|
|
784
|
+
readonly packIds: readonly ["concept/explicit-authoring"];
|
|
785
|
+
}, {
|
|
786
|
+
readonly id: "open-markdown";
|
|
787
|
+
readonly type: "concept";
|
|
788
|
+
readonly title: "Open Markdown baseline";
|
|
789
|
+
readonly summary: "Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.";
|
|
790
|
+
readonly aliases: readonly [];
|
|
791
|
+
readonly audiences: readonly ["developers"];
|
|
792
|
+
readonly tags: readonly ["agents", "packaging"];
|
|
793
|
+
readonly goals: readonly [];
|
|
794
|
+
readonly path: "concepts/open-markdown.md";
|
|
795
|
+
readonly webPath: "/concepts/open-markdown";
|
|
796
|
+
readonly prerequisites: readonly [];
|
|
797
|
+
readonly related: readonly ["explicit-authoring"];
|
|
798
|
+
readonly packIds: readonly ["concept/open-markdown"];
|
|
799
|
+
}, {
|
|
800
|
+
readonly id: "guide-vs-scenario";
|
|
801
|
+
readonly type: "concept";
|
|
802
|
+
readonly title: "Guides vs scenarios vs journeys";
|
|
803
|
+
readonly summary: "Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.";
|
|
804
|
+
readonly aliases: readonly [];
|
|
805
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
806
|
+
readonly tags: readonly ["authoring"];
|
|
807
|
+
readonly goals: readonly [];
|
|
808
|
+
readonly path: "concepts/guide-vs-scenario.md";
|
|
809
|
+
readonly webPath: "/concepts/guide-vs-scenario";
|
|
810
|
+
readonly prerequisites: readonly [];
|
|
811
|
+
readonly related: readonly ["explicit-authoring"];
|
|
812
|
+
readonly packIds: readonly ["concept/guide-vs-scenario"];
|
|
813
|
+
}, {
|
|
814
|
+
readonly id: "scaffold-concept";
|
|
815
|
+
readonly type: "guide";
|
|
816
|
+
readonly title: "Scaffold a concept page";
|
|
817
|
+
readonly summary: "Create a validated concept with problem, why, and mental model.";
|
|
818
|
+
readonly aliases: readonly [];
|
|
819
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
820
|
+
readonly tags: readonly ["authoring"];
|
|
821
|
+
readonly goals: readonly [];
|
|
822
|
+
readonly path: "guides/scaffold-concept.md";
|
|
823
|
+
readonly webPath: "/guides/scaffold-concept";
|
|
824
|
+
readonly prerequisites: readonly [];
|
|
825
|
+
readonly related: readonly ["explicit-authoring"];
|
|
826
|
+
readonly packIds: readonly ["guide/scaffold-concept"];
|
|
827
|
+
}, {
|
|
828
|
+
readonly id: "choose-content-type";
|
|
829
|
+
readonly type: "scenario";
|
|
830
|
+
readonly title: "Choose the right Docify content type";
|
|
831
|
+
readonly summary: "Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.";
|
|
832
|
+
readonly aliases: readonly [];
|
|
833
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
834
|
+
readonly tags: readonly [];
|
|
835
|
+
readonly goals: readonly ["Which Docify content type fits this goal?"];
|
|
836
|
+
readonly path: "scenarios/choose-content-type.md";
|
|
837
|
+
readonly webPath: "/scenarios/choose-content-type";
|
|
838
|
+
readonly prerequisites: readonly [];
|
|
839
|
+
readonly related: readonly [];
|
|
840
|
+
readonly packIds: readonly ["scenario/choose-content-type"];
|
|
841
|
+
}, {
|
|
842
|
+
readonly id: "docify";
|
|
843
|
+
readonly type: "glossary";
|
|
844
|
+
readonly title: "Docify";
|
|
845
|
+
readonly summary: "x12i framework that turns explicitly authored product knowledge into a website and agent package.";
|
|
846
|
+
readonly aliases: readonly ["x12i-docify"];
|
|
847
|
+
readonly audiences: readonly [];
|
|
848
|
+
readonly tags: readonly [];
|
|
849
|
+
readonly goals: readonly [];
|
|
850
|
+
readonly path: "glossary/docify.md";
|
|
851
|
+
readonly prerequisites: readonly [];
|
|
852
|
+
readonly related: readonly ["explicit-authoring"];
|
|
853
|
+
readonly packIds: readonly [];
|
|
854
|
+
}, {
|
|
855
|
+
readonly id: "search-json";
|
|
856
|
+
readonly type: "glossary";
|
|
857
|
+
readonly title: "SEARCH.json";
|
|
858
|
+
readonly summary: "Deterministic local search index over all addressable knowledge items.";
|
|
859
|
+
readonly aliases: readonly ["search index"];
|
|
860
|
+
readonly audiences: readonly [];
|
|
861
|
+
readonly tags: readonly [];
|
|
862
|
+
readonly goals: readonly [];
|
|
863
|
+
readonly path: "glossary/search-json.md";
|
|
864
|
+
readonly prerequisites: readonly [];
|
|
865
|
+
readonly related: readonly ["open-markdown"];
|
|
866
|
+
readonly packIds: readonly [];
|
|
867
|
+
}, {
|
|
868
|
+
readonly id: "docify-dual-audience";
|
|
869
|
+
readonly type: "diagram";
|
|
870
|
+
readonly title: "One library, two consumption surfaces";
|
|
871
|
+
readonly summary: "Explicitly authored content becomes a human website and an agent knowledge package.";
|
|
872
|
+
readonly aliases: readonly [];
|
|
873
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
874
|
+
readonly tags: readonly ["platform"];
|
|
875
|
+
readonly goals: readonly [];
|
|
876
|
+
readonly path: "diagrams/docify-dual-audience.md";
|
|
877
|
+
readonly webPath: "/diagrams/docify-dual-audience";
|
|
878
|
+
readonly prerequisites: readonly [];
|
|
879
|
+
readonly related: readonly ["explicit-authoring", "open-markdown"];
|
|
880
|
+
readonly packIds: readonly [];
|
|
881
|
+
}, {
|
|
882
|
+
readonly id: "orient-docify";
|
|
883
|
+
readonly type: "use-case";
|
|
884
|
+
readonly title: "Orient on x12i-docify";
|
|
885
|
+
readonly summary: "Understand the dual-audience platform and where product libraries fit.";
|
|
886
|
+
readonly aliases: readonly [];
|
|
887
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
888
|
+
readonly tags: readonly ["platform", "start-here"];
|
|
889
|
+
readonly goals: readonly ["Understand the dual-audience platform and where product libraries fit."];
|
|
890
|
+
readonly path: "use-cases/orient-docify.md";
|
|
891
|
+
readonly webPath: "/use-cases#orient-docify";
|
|
892
|
+
readonly prerequisites: readonly [];
|
|
893
|
+
readonly related: readonly ["00-platform-overview"];
|
|
894
|
+
readonly packIds: readonly ["use-case/orient-docify"];
|
|
895
|
+
}, {
|
|
896
|
+
readonly id: "map-packages";
|
|
897
|
+
readonly type: "use-case";
|
|
898
|
+
readonly title: "Map the @x12i/docify-* packages";
|
|
899
|
+
readonly summary: "Know which package owns schemas, theme, render, export, SDK, web, and screenshots.";
|
|
900
|
+
readonly aliases: readonly [];
|
|
901
|
+
readonly audiences: readonly ["developers"];
|
|
902
|
+
readonly tags: readonly ["packages", "npm"];
|
|
903
|
+
readonly goals: readonly ["Know which package owns schemas, theme, render, export, SDK, web, and screenshots."];
|
|
904
|
+
readonly path: "use-cases/map-packages.md";
|
|
905
|
+
readonly webPath: "/use-cases#map-packages";
|
|
906
|
+
readonly prerequisites: readonly [];
|
|
907
|
+
readonly related: readonly ["01-packages"];
|
|
908
|
+
readonly packIds: readonly ["use-case/map-packages"];
|
|
909
|
+
}, {
|
|
910
|
+
readonly id: "wire-product-library";
|
|
911
|
+
readonly type: "use-case";
|
|
912
|
+
readonly title: "Wire a product docs library";
|
|
913
|
+
readonly summary: "Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.";
|
|
914
|
+
readonly aliases: readonly [];
|
|
915
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
916
|
+
readonly tags: readonly ["authoring", "getting-started"];
|
|
917
|
+
readonly goals: readonly ["Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web."];
|
|
918
|
+
readonly path: "use-cases/wire-product-library.md";
|
|
919
|
+
readonly webPath: "/use-cases#wire-product-library";
|
|
920
|
+
readonly prerequisites: readonly [];
|
|
921
|
+
readonly related: readonly ["02-authoring", "05-design"];
|
|
922
|
+
readonly packIds: readonly ["use-case/wire-product-library"];
|
|
923
|
+
}, {
|
|
924
|
+
readonly id: "ship-human-site";
|
|
925
|
+
readonly type: "use-case";
|
|
926
|
+
readonly title: "Ship the human web app";
|
|
927
|
+
readonly summary: "Build and serve dist/web with roles, use cases, catalog, and chapter reader.";
|
|
928
|
+
readonly aliases: readonly [];
|
|
929
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
930
|
+
readonly tags: readonly ["humans", "web"];
|
|
931
|
+
readonly goals: readonly ["Build and serve dist/web with roles, use cases, catalog, and chapter reader."];
|
|
932
|
+
readonly path: "use-cases/ship-human-site.md";
|
|
933
|
+
readonly webPath: "/use-cases#ship-human-site";
|
|
934
|
+
readonly prerequisites: readonly [];
|
|
935
|
+
readonly related: readonly ["03-for-humans"];
|
|
936
|
+
readonly packIds: readonly ["use-case/ship-human-site"];
|
|
937
|
+
}, {
|
|
938
|
+
readonly id: "ship-agent-packs";
|
|
939
|
+
readonly type: "use-case";
|
|
940
|
+
readonly title: "Ship agent markdown and knowledge SDK";
|
|
941
|
+
readonly summary: "Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.";
|
|
942
|
+
readonly aliases: readonly [];
|
|
943
|
+
readonly audiences: readonly ["developers"];
|
|
944
|
+
readonly tags: readonly ["agents", "sdk"];
|
|
945
|
+
readonly goals: readonly ["Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D."];
|
|
946
|
+
readonly path: "use-cases/ship-agent-packs.md";
|
|
947
|
+
readonly webPath: "/use-cases#ship-agent-packs";
|
|
948
|
+
readonly prerequisites: readonly [];
|
|
949
|
+
readonly related: readonly ["04-for-agents"];
|
|
950
|
+
readonly packIds: readonly ["use-case/ship-agent-packs"];
|
|
951
|
+
}, {
|
|
952
|
+
readonly id: "keep-one-design";
|
|
953
|
+
readonly type: "use-case";
|
|
954
|
+
readonly title: "Keep one design system";
|
|
955
|
+
readonly summary: "Change product naming and content only — never fork theme or invent a competing palette.";
|
|
956
|
+
readonly aliases: readonly [];
|
|
957
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
958
|
+
readonly tags: readonly ["design", "theme"];
|
|
959
|
+
readonly goals: readonly ["Change product naming and content only — never fork theme or invent a competing palette."];
|
|
960
|
+
readonly path: "use-cases/keep-one-design.md";
|
|
961
|
+
readonly webPath: "/use-cases#keep-one-design";
|
|
962
|
+
readonly prerequisites: readonly [];
|
|
963
|
+
readonly related: readonly ["05-design"];
|
|
964
|
+
readonly packIds: readonly ["use-case/keep-one-design"];
|
|
965
|
+
}, {
|
|
966
|
+
readonly id: "00-platform-overview";
|
|
967
|
+
readonly type: "book";
|
|
968
|
+
readonly title: "Platform Overview";
|
|
969
|
+
readonly summary: "What x12i-docify is, who it serves, and how product libraries plug in without forking UI.";
|
|
970
|
+
readonly aliases: readonly ["CASE FILE · DOC-00"];
|
|
971
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
972
|
+
readonly tags: readonly ["platform", "start-here", "overview"];
|
|
973
|
+
readonly goals: readonly [];
|
|
974
|
+
readonly path: "books/00-platform-overview/";
|
|
975
|
+
readonly webPath: "/books/00-platform-overview";
|
|
976
|
+
readonly prerequisites: readonly [];
|
|
977
|
+
readonly related: readonly [];
|
|
978
|
+
readonly packIds: readonly [];
|
|
979
|
+
}, {
|
|
980
|
+
readonly id: "01-packages";
|
|
981
|
+
readonly type: "book";
|
|
982
|
+
readonly title: "Packages";
|
|
983
|
+
readonly summary: "Core, theme, render, export, SDK, web, and screenshots — what each package owns.";
|
|
984
|
+
readonly aliases: readonly ["CASE FILE · DOC-01"];
|
|
985
|
+
readonly audiences: readonly ["developers"];
|
|
986
|
+
readonly tags: readonly ["packages", "npm", "platform"];
|
|
987
|
+
readonly goals: readonly [];
|
|
988
|
+
readonly path: "books/01-packages/";
|
|
989
|
+
readonly webPath: "/books/01-packages";
|
|
990
|
+
readonly prerequisites: readonly [];
|
|
991
|
+
readonly related: readonly [];
|
|
992
|
+
readonly packIds: readonly [];
|
|
993
|
+
}, {
|
|
994
|
+
readonly id: "02-authoring";
|
|
995
|
+
readonly type: "book";
|
|
996
|
+
readonly title: "Authoring a Library";
|
|
997
|
+
readonly summary: "Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.";
|
|
998
|
+
readonly aliases: readonly ["CASE FILE · DOC-02"];
|
|
999
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
1000
|
+
readonly tags: readonly ["authoring", "content", "getting-started"];
|
|
1001
|
+
readonly goals: readonly [];
|
|
1002
|
+
readonly path: "books/02-authoring/";
|
|
1003
|
+
readonly webPath: "/books/02-authoring";
|
|
1004
|
+
readonly prerequisites: readonly [];
|
|
1005
|
+
readonly related: readonly [];
|
|
1006
|
+
readonly packIds: readonly [];
|
|
1007
|
+
}, {
|
|
1008
|
+
readonly id: "03-for-humans";
|
|
1009
|
+
readonly type: "book";
|
|
1010
|
+
readonly title: "For Humans";
|
|
1011
|
+
readonly summary: "How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.";
|
|
1012
|
+
readonly aliases: readonly ["CASE FILE · DOC-03"];
|
|
1013
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
1014
|
+
readonly tags: readonly ["humans", "web", "reader"];
|
|
1015
|
+
readonly goals: readonly [];
|
|
1016
|
+
readonly path: "books/03-for-humans/";
|
|
1017
|
+
readonly webPath: "/books/03-for-humans";
|
|
1018
|
+
readonly prerequisites: readonly [];
|
|
1019
|
+
readonly related: readonly [];
|
|
1020
|
+
readonly packIds: readonly [];
|
|
1021
|
+
}, {
|
|
1022
|
+
readonly id: "04-for-agents";
|
|
1023
|
+
readonly type: "book";
|
|
1024
|
+
readonly title: "For Agents";
|
|
1025
|
+
readonly summary: "MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.";
|
|
1026
|
+
readonly aliases: readonly ["CASE FILE · DOC-04"];
|
|
1027
|
+
readonly audiences: readonly ["developers"];
|
|
1028
|
+
readonly tags: readonly ["agents", "sdk", "markdown"];
|
|
1029
|
+
readonly goals: readonly [];
|
|
1030
|
+
readonly path: "books/04-for-agents/";
|
|
1031
|
+
readonly webPath: "/books/04-for-agents";
|
|
1032
|
+
readonly prerequisites: readonly [];
|
|
1033
|
+
readonly related: readonly [];
|
|
1034
|
+
readonly packIds: readonly [];
|
|
1035
|
+
}, {
|
|
1036
|
+
readonly id: "05-design";
|
|
1037
|
+
readonly type: "book";
|
|
1038
|
+
readonly title: "Design System";
|
|
1039
|
+
readonly summary: "Shared theme tokens and surfaces — products change naming and content only.";
|
|
1040
|
+
readonly aliases: readonly ["CASE FILE · DOC-05"];
|
|
1041
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
1042
|
+
readonly tags: readonly ["design", "theme", "brand"];
|
|
1043
|
+
readonly goals: readonly [];
|
|
1044
|
+
readonly path: "books/05-design/";
|
|
1045
|
+
readonly webPath: "/books/05-design";
|
|
1046
|
+
readonly prerequisites: readonly [];
|
|
1047
|
+
readonly related: readonly [];
|
|
1048
|
+
readonly packIds: readonly [];
|
|
1049
|
+
}, {
|
|
1050
|
+
readonly id: "06-getting-started-and-tutorials";
|
|
1051
|
+
readonly type: "book";
|
|
1052
|
+
readonly title: "Getting Started & Tutorials";
|
|
1053
|
+
readonly summary: "Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.";
|
|
1054
|
+
readonly aliases: readonly ["CASE FILE · DOC-06"];
|
|
1055
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
1056
|
+
readonly tags: readonly ["getting-started", "tutorials", "install", "start-here"];
|
|
1057
|
+
readonly goals: readonly [];
|
|
1058
|
+
readonly path: "books/06-getting-started-and-tutorials/";
|
|
1059
|
+
readonly webPath: "/books/06-getting-started-and-tutorials";
|
|
1060
|
+
readonly prerequisites: readonly [];
|
|
1061
|
+
readonly related: readonly [];
|
|
1062
|
+
readonly packIds: readonly [];
|
|
1063
|
+
}];
|
|
356
1064
|
};
|
|
357
1065
|
export declare const files: Record<string, string>;
|
|
358
1066
|
//# sourceMappingURL=bundle.d.ts.map
|