@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
package/dist/generated/bundle.js
CHANGED
|
@@ -142,6 +142,27 @@ export const catalog = {
|
|
|
142
142
|
],
|
|
143
143
|
"color": "#16324f",
|
|
144
144
|
"dir": "05-design"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"id": "06-getting-started-and-tutorials",
|
|
148
|
+
"familyId": "docify",
|
|
149
|
+
"audiences": [
|
|
150
|
+
"developers",
|
|
151
|
+
"builders"
|
|
152
|
+
],
|
|
153
|
+
"status": "available",
|
|
154
|
+
"kicker": "CASE FILE · DOC-06",
|
|
155
|
+
"title": "Getting Started & Tutorials",
|
|
156
|
+
"subtitle": "Install, run, author, publish",
|
|
157
|
+
"blurb": "Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.",
|
|
158
|
+
"tags": [
|
|
159
|
+
"getting-started",
|
|
160
|
+
"tutorials",
|
|
161
|
+
"install",
|
|
162
|
+
"start-here"
|
|
163
|
+
],
|
|
164
|
+
"color": "#1f6e5c",
|
|
165
|
+
"dir": "06-getting-started-and-tutorials"
|
|
145
166
|
}
|
|
146
167
|
]
|
|
147
168
|
};
|
|
@@ -173,7 +194,13 @@ export const useCases = {
|
|
|
173
194
|
],
|
|
174
195
|
"alsoSee": [
|
|
175
196
|
"00-platform-overview"
|
|
176
|
-
]
|
|
197
|
+
],
|
|
198
|
+
"prerequisites": [],
|
|
199
|
+
"successCriteria": [],
|
|
200
|
+
"nextUseCases": [],
|
|
201
|
+
"scenarioIds": [],
|
|
202
|
+
"guideIds": [],
|
|
203
|
+
"troubleshooting": []
|
|
177
204
|
},
|
|
178
205
|
{
|
|
179
206
|
"id": "map-packages",
|
|
@@ -199,7 +226,13 @@ export const useCases = {
|
|
|
199
226
|
],
|
|
200
227
|
"alsoSee": [
|
|
201
228
|
"01-packages"
|
|
202
|
-
]
|
|
229
|
+
],
|
|
230
|
+
"prerequisites": [],
|
|
231
|
+
"successCriteria": [],
|
|
232
|
+
"nextUseCases": [],
|
|
233
|
+
"scenarioIds": [],
|
|
234
|
+
"guideIds": [],
|
|
235
|
+
"troubleshooting": []
|
|
203
236
|
},
|
|
204
237
|
{
|
|
205
238
|
"id": "wire-product-library",
|
|
@@ -228,7 +261,13 @@ export const useCases = {
|
|
|
228
261
|
"alsoSee": [
|
|
229
262
|
"02-authoring",
|
|
230
263
|
"05-design"
|
|
231
|
-
]
|
|
264
|
+
],
|
|
265
|
+
"prerequisites": [],
|
|
266
|
+
"successCriteria": [],
|
|
267
|
+
"nextUseCases": [],
|
|
268
|
+
"scenarioIds": [],
|
|
269
|
+
"guideIds": [],
|
|
270
|
+
"troubleshooting": []
|
|
232
271
|
},
|
|
233
272
|
{
|
|
234
273
|
"id": "ship-human-site",
|
|
@@ -255,7 +294,13 @@ export const useCases = {
|
|
|
255
294
|
],
|
|
256
295
|
"alsoSee": [
|
|
257
296
|
"03-for-humans"
|
|
258
|
-
]
|
|
297
|
+
],
|
|
298
|
+
"prerequisites": [],
|
|
299
|
+
"successCriteria": [],
|
|
300
|
+
"nextUseCases": [],
|
|
301
|
+
"scenarioIds": [],
|
|
302
|
+
"guideIds": [],
|
|
303
|
+
"troubleshooting": []
|
|
259
304
|
},
|
|
260
305
|
{
|
|
261
306
|
"id": "ship-agent-packs",
|
|
@@ -282,7 +327,13 @@ export const useCases = {
|
|
|
282
327
|
],
|
|
283
328
|
"alsoSee": [
|
|
284
329
|
"04-for-agents"
|
|
285
|
-
]
|
|
330
|
+
],
|
|
331
|
+
"prerequisites": [],
|
|
332
|
+
"successCriteria": [],
|
|
333
|
+
"nextUseCases": [],
|
|
334
|
+
"scenarioIds": [],
|
|
335
|
+
"guideIds": [],
|
|
336
|
+
"troubleshooting": []
|
|
286
337
|
},
|
|
287
338
|
{
|
|
288
339
|
"id": "keep-one-design",
|
|
@@ -310,7 +361,13 @@ export const useCases = {
|
|
|
310
361
|
],
|
|
311
362
|
"alsoSee": [
|
|
312
363
|
"05-design"
|
|
313
|
-
]
|
|
364
|
+
],
|
|
365
|
+
"prerequisites": [],
|
|
366
|
+
"successCriteria": [],
|
|
367
|
+
"nextUseCases": [],
|
|
368
|
+
"scenarioIds": [],
|
|
369
|
+
"guideIds": [],
|
|
370
|
+
"troubleshooting": []
|
|
314
371
|
}
|
|
315
372
|
]
|
|
316
373
|
};
|
|
@@ -329,6 +386,14 @@ export const site = {
|
|
|
329
386
|
"label": "Getting started",
|
|
330
387
|
"href": "/getting-started"
|
|
331
388
|
},
|
|
389
|
+
{
|
|
390
|
+
"label": "Journey",
|
|
391
|
+
"href": "/journey"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"label": "Search",
|
|
395
|
+
"href": "/search"
|
|
396
|
+
},
|
|
332
397
|
{
|
|
333
398
|
"label": "Use cases",
|
|
334
399
|
"href": "/use-cases"
|
|
@@ -347,6 +412,26 @@ export const site = {
|
|
|
347
412
|
"label": "Getting started",
|
|
348
413
|
"href": "/getting-started"
|
|
349
414
|
},
|
|
415
|
+
{
|
|
416
|
+
"label": "Journey",
|
|
417
|
+
"href": "/journey"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"label": "Search",
|
|
421
|
+
"href": "/search"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"label": "Explore",
|
|
425
|
+
"href": "/explore"
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"label": "Concepts",
|
|
429
|
+
"href": "/concepts"
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
"label": "Guides",
|
|
433
|
+
"href": "/guides"
|
|
434
|
+
},
|
|
350
435
|
{
|
|
351
436
|
"label": "Use cases",
|
|
352
437
|
"href": "/use-cases"
|
|
@@ -480,6 +565,25 @@ export const manifest = {
|
|
|
480
565
|
"developers": "downloads/books/05-design/developers.chapters.json",
|
|
481
566
|
"builders": "downloads/books/05-design/builders.chapters.json"
|
|
482
567
|
}
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"id": "06-getting-started-and-tutorials",
|
|
571
|
+
"audiences": [
|
|
572
|
+
"developers",
|
|
573
|
+
"builders"
|
|
574
|
+
],
|
|
575
|
+
"md": {
|
|
576
|
+
"developers": "downloads/books/06-getting-started-and-tutorials/developers.md",
|
|
577
|
+
"builders": "downloads/books/06-getting-started-and-tutorials/builders.md"
|
|
578
|
+
},
|
|
579
|
+
"pdf": {
|
|
580
|
+
"developers": null,
|
|
581
|
+
"builders": null
|
|
582
|
+
},
|
|
583
|
+
"chapters": {
|
|
584
|
+
"developers": "downloads/books/06-getting-started-and-tutorials/developers.chapters.json",
|
|
585
|
+
"builders": "downloads/books/06-getting-started-and-tutorials/builders.chapters.json"
|
|
586
|
+
}
|
|
483
587
|
}
|
|
484
588
|
],
|
|
485
589
|
"useCases": [
|
|
@@ -583,13 +687,991 @@ export const manifest = {
|
|
|
583
687
|
}
|
|
584
688
|
]
|
|
585
689
|
}
|
|
690
|
+
],
|
|
691
|
+
"indexes": {
|
|
692
|
+
"indexMd": "INDEX.md",
|
|
693
|
+
"searchJson": "SEARCH.json"
|
|
694
|
+
},
|
|
695
|
+
"concepts": [
|
|
696
|
+
{
|
|
697
|
+
"id": "explicit-authoring",
|
|
698
|
+
"title": "Explicit authoring",
|
|
699
|
+
"md": "concepts/explicit-authoring.md"
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"id": "open-markdown",
|
|
703
|
+
"title": "Open Markdown baseline",
|
|
704
|
+
"md": "concepts/open-markdown.md"
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"id": "guide-vs-scenario",
|
|
708
|
+
"title": "Guides vs scenarios vs journeys",
|
|
709
|
+
"md": "concepts/guide-vs-scenario.md"
|
|
710
|
+
}
|
|
711
|
+
],
|
|
712
|
+
"guides": [
|
|
713
|
+
{
|
|
714
|
+
"id": "scaffold-concept",
|
|
715
|
+
"title": "Scaffold a concept page",
|
|
716
|
+
"md": "guides/scaffold-concept.md"
|
|
717
|
+
}
|
|
718
|
+
],
|
|
719
|
+
"scenarios": [
|
|
720
|
+
{
|
|
721
|
+
"id": "choose-content-type",
|
|
722
|
+
"title": "Choose the right Docify content type",
|
|
723
|
+
"md": "scenarios/choose-content-type.md"
|
|
724
|
+
}
|
|
725
|
+
],
|
|
726
|
+
"decisions": [],
|
|
727
|
+
"glossary": [
|
|
728
|
+
{
|
|
729
|
+
"id": "docify",
|
|
730
|
+
"term": "Docify",
|
|
731
|
+
"md": "glossary/docify.md"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"id": "search-json",
|
|
735
|
+
"term": "SEARCH.json",
|
|
736
|
+
"md": "glossary/search-json.md"
|
|
737
|
+
}
|
|
738
|
+
],
|
|
739
|
+
"visuals": [],
|
|
740
|
+
"diagrams": [
|
|
741
|
+
{
|
|
742
|
+
"id": "docify-dual-audience",
|
|
743
|
+
"title": "One library, two consumption surfaces",
|
|
744
|
+
"md": "diagrams/docify-dual-audience.md",
|
|
745
|
+
"source": "diagrams/sources/docify-dual-audience.mmd"
|
|
746
|
+
}
|
|
747
|
+
],
|
|
748
|
+
"relationships": [
|
|
749
|
+
{
|
|
750
|
+
"id": "explicit-to-open-md",
|
|
751
|
+
"type": "prerequisiteOf",
|
|
752
|
+
"from": "explicit-authoring",
|
|
753
|
+
"to": "open-markdown"
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
"id": "types-related",
|
|
757
|
+
"type": "relatedTo",
|
|
758
|
+
"from": "guide-vs-scenario",
|
|
759
|
+
"to": "explicit-authoring"
|
|
760
|
+
}
|
|
761
|
+
],
|
|
762
|
+
"tutorials": [],
|
|
763
|
+
"examples": [],
|
|
764
|
+
"sampleData": [],
|
|
765
|
+
"uiClients": [],
|
|
766
|
+
"apis": [],
|
|
767
|
+
"packs": [
|
|
768
|
+
{
|
|
769
|
+
"id": "concept/explicit-authoring",
|
|
770
|
+
"type": "concept",
|
|
771
|
+
"path": "packs/concept/explicit-authoring"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"id": "concept/open-markdown",
|
|
775
|
+
"type": "concept",
|
|
776
|
+
"path": "packs/concept/open-markdown"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"id": "concept/guide-vs-scenario",
|
|
780
|
+
"type": "concept",
|
|
781
|
+
"path": "packs/concept/guide-vs-scenario"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"id": "guide/scaffold-concept",
|
|
785
|
+
"type": "guide",
|
|
786
|
+
"path": "packs/guide/scaffold-concept"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"id": "scenario/choose-content-type",
|
|
790
|
+
"type": "scenario",
|
|
791
|
+
"path": "packs/scenario/choose-content-type"
|
|
792
|
+
}
|
|
793
|
+
]
|
|
794
|
+
};
|
|
795
|
+
export const knowledge = {
|
|
796
|
+
"concepts": [
|
|
797
|
+
{
|
|
798
|
+
"summary": "Docify only builds knowledge that authors declare — it never discovers product truth from source.",
|
|
799
|
+
"problem": "Auto-scanning repositories invents incomplete or wrong documentation.",
|
|
800
|
+
"why": "Accessibility requires intentional explanations, relationships, and confirmation boundaries.",
|
|
801
|
+
"mentalModel": "Authors understand; Docify packages and presents.",
|
|
802
|
+
"audiences": [
|
|
803
|
+
"developers",
|
|
804
|
+
"builders"
|
|
805
|
+
],
|
|
806
|
+
"whenItMatters": [
|
|
807
|
+
"Starting a docs library",
|
|
808
|
+
"Asking an agent to document a product"
|
|
809
|
+
],
|
|
810
|
+
"whenNotToUse": [],
|
|
811
|
+
"prerequisites": [],
|
|
812
|
+
"related": [
|
|
813
|
+
"open-markdown",
|
|
814
|
+
"knowledge-relationships"
|
|
815
|
+
],
|
|
816
|
+
"next": [
|
|
817
|
+
"open-markdown"
|
|
818
|
+
],
|
|
819
|
+
"exampleIds": [],
|
|
820
|
+
"commonMistakes": [],
|
|
821
|
+
"successCriteria": [],
|
|
822
|
+
"invariants": [],
|
|
823
|
+
"alternatives": [],
|
|
824
|
+
"tags": [
|
|
825
|
+
"authoring",
|
|
826
|
+
"boundary"
|
|
827
|
+
],
|
|
828
|
+
"id": "explicit-authoring",
|
|
829
|
+
"type": "concept",
|
|
830
|
+
"title": "Explicit authoring",
|
|
831
|
+
"visualIds": [],
|
|
832
|
+
"diagramIds": [],
|
|
833
|
+
"referenceIds": []
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"summary": "Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.",
|
|
837
|
+
"problem": "Knowledge trapped in generated JS or HTML blocks offline and agent workflows.",
|
|
838
|
+
"why": "Agents and humans must grep, read, and pack the same facts without executing code.",
|
|
839
|
+
"mentalModel": "INDEX.md and SEARCH.json are the door; Markdown files are the rooms.",
|
|
840
|
+
"audiences": [
|
|
841
|
+
"developers"
|
|
842
|
+
],
|
|
843
|
+
"whenItMatters": [],
|
|
844
|
+
"whenNotToUse": [],
|
|
845
|
+
"prerequisites": [],
|
|
846
|
+
"related": [
|
|
847
|
+
"explicit-authoring"
|
|
848
|
+
],
|
|
849
|
+
"next": [
|
|
850
|
+
"guide-vs-scenario"
|
|
851
|
+
],
|
|
852
|
+
"exampleIds": [],
|
|
853
|
+
"commonMistakes": [],
|
|
854
|
+
"successCriteria": [],
|
|
855
|
+
"invariants": [],
|
|
856
|
+
"alternatives": [],
|
|
857
|
+
"tags": [
|
|
858
|
+
"agents",
|
|
859
|
+
"packaging"
|
|
860
|
+
],
|
|
861
|
+
"id": "open-markdown",
|
|
862
|
+
"type": "concept",
|
|
863
|
+
"title": "Open Markdown baseline",
|
|
864
|
+
"visualIds": [],
|
|
865
|
+
"diagramIds": [],
|
|
866
|
+
"referenceIds": []
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"summary": "Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.",
|
|
870
|
+
"problem": "Mixing learning, diagnosis, and production procedures confuses agents and operators.",
|
|
871
|
+
"why": "Clear types keep invariants and confirmation boundaries enforceable.",
|
|
872
|
+
"mentalModel": "Scenario chooses a guide; journey sequences several guides and decisions.",
|
|
873
|
+
"audiences": [
|
|
874
|
+
"developers",
|
|
875
|
+
"builders"
|
|
876
|
+
],
|
|
877
|
+
"whenItMatters": [],
|
|
878
|
+
"whenNotToUse": [],
|
|
879
|
+
"prerequisites": [],
|
|
880
|
+
"related": [
|
|
881
|
+
"explicit-authoring"
|
|
882
|
+
],
|
|
883
|
+
"next": [],
|
|
884
|
+
"exampleIds": [],
|
|
885
|
+
"commonMistakes": [],
|
|
886
|
+
"successCriteria": [],
|
|
887
|
+
"invariants": [],
|
|
888
|
+
"alternatives": [],
|
|
889
|
+
"tags": [
|
|
890
|
+
"authoring"
|
|
891
|
+
],
|
|
892
|
+
"id": "guide-vs-scenario",
|
|
893
|
+
"type": "concept",
|
|
894
|
+
"title": "Guides vs scenarios vs journeys",
|
|
895
|
+
"visualIds": [],
|
|
896
|
+
"diagramIds": [],
|
|
897
|
+
"referenceIds": []
|
|
898
|
+
}
|
|
899
|
+
],
|
|
900
|
+
"guides": [
|
|
901
|
+
{
|
|
902
|
+
"summary": "Create a validated concept with problem, why, and mental model.",
|
|
903
|
+
"why": "Concepts without why become unusable glossary stubs.",
|
|
904
|
+
"audiences": [
|
|
905
|
+
"developers",
|
|
906
|
+
"builders"
|
|
907
|
+
],
|
|
908
|
+
"whenItMatters": [],
|
|
909
|
+
"whenNotToUse": [],
|
|
910
|
+
"prerequisites": [],
|
|
911
|
+
"related": [
|
|
912
|
+
"explicit-authoring"
|
|
913
|
+
],
|
|
914
|
+
"next": [],
|
|
915
|
+
"exampleIds": [],
|
|
916
|
+
"commonMistakes": [],
|
|
917
|
+
"successCriteria": [],
|
|
918
|
+
"invariants": [
|
|
919
|
+
"Docify does not invent the concept from source code"
|
|
920
|
+
],
|
|
921
|
+
"alternatives": [],
|
|
922
|
+
"confirmationRequired": false,
|
|
923
|
+
"tags": [
|
|
924
|
+
"authoring"
|
|
925
|
+
],
|
|
926
|
+
"id": "scaffold-concept",
|
|
927
|
+
"type": "guide",
|
|
928
|
+
"title": "Scaffold a concept page",
|
|
929
|
+
"useWhen": [
|
|
930
|
+
"Documenting a product idea that needs explanation first"
|
|
931
|
+
],
|
|
932
|
+
"doNotUseWhen": [
|
|
933
|
+
"Writing a step-by-step production procedure (use a guide)"
|
|
934
|
+
],
|
|
935
|
+
"inputs": [],
|
|
936
|
+
"permissions": [],
|
|
937
|
+
"steps": [
|
|
938
|
+
{
|
|
939
|
+
"id": "scaffold",
|
|
940
|
+
"title": "Run docify scaffold concept <id>",
|
|
941
|
+
"expectedResult": "Markdown file under concepts/",
|
|
942
|
+
"optional": false
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"id": "fill",
|
|
946
|
+
"title": "Fill summary, problem, why, mental model",
|
|
947
|
+
"expectedResult": "Human-understanding fields present",
|
|
948
|
+
"optional": false
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"id": "validate",
|
|
952
|
+
"title": "Run docify validate",
|
|
953
|
+
"expectedResult": "Validation passes",
|
|
954
|
+
"optional": false
|
|
955
|
+
}
|
|
956
|
+
],
|
|
957
|
+
"verification": [
|
|
958
|
+
"Concept appears in INDEX.md after build"
|
|
959
|
+
],
|
|
960
|
+
"recovery": [],
|
|
961
|
+
"tutorialIds": [],
|
|
962
|
+
"referenceIds": [],
|
|
963
|
+
"scenarioIds": []
|
|
964
|
+
}
|
|
965
|
+
],
|
|
966
|
+
"scenarios": [
|
|
967
|
+
{
|
|
968
|
+
"summary": "Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.",
|
|
969
|
+
"audiences": [
|
|
970
|
+
"developers",
|
|
971
|
+
"builders"
|
|
972
|
+
],
|
|
973
|
+
"whenItMatters": [],
|
|
974
|
+
"whenNotToUse": [],
|
|
975
|
+
"prerequisites": [],
|
|
976
|
+
"related": [],
|
|
977
|
+
"next": [],
|
|
978
|
+
"exampleIds": [],
|
|
979
|
+
"commonMistakes": [],
|
|
980
|
+
"successCriteria": [],
|
|
981
|
+
"invariants": [
|
|
982
|
+
"Do not invent unsupported actions from a broad why statement"
|
|
983
|
+
],
|
|
984
|
+
"alternatives": [],
|
|
985
|
+
"tags": [],
|
|
986
|
+
"id": "choose-content-type",
|
|
987
|
+
"type": "scenario",
|
|
988
|
+
"title": "Choose the right Docify content type",
|
|
989
|
+
"situation": "An agent is asked to document a product behavior and is unsure which file to create.",
|
|
990
|
+
"preconditions": [
|
|
991
|
+
"Product material is explicitly supplied"
|
|
992
|
+
],
|
|
993
|
+
"signals": [
|
|
994
|
+
"Need a definition and why",
|
|
995
|
+
"Need a bounded production procedure",
|
|
996
|
+
"Need branching on observed state",
|
|
997
|
+
"Need safe rehearsal with sample data"
|
|
998
|
+
],
|
|
999
|
+
"decisionQuestion": "Which Docify content type fits this goal?",
|
|
1000
|
+
"paths": [
|
|
1001
|
+
{
|
|
1002
|
+
"id": "concept",
|
|
1003
|
+
"label": "Author a concept",
|
|
1004
|
+
"when": "The reader needs what it is and why it exists",
|
|
1005
|
+
"rationale": "Concepts carry mental models before procedures.",
|
|
1006
|
+
"guideIds": [
|
|
1007
|
+
"scaffold-concept"
|
|
1008
|
+
]
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"id": "guide",
|
|
1012
|
+
"label": "Author a guide",
|
|
1013
|
+
"when": "The reader needs a bounded task with verification",
|
|
1014
|
+
"rationale": "Guides are normative procedures with confirmation boundaries.",
|
|
1015
|
+
"guideIds": [
|
|
1016
|
+
"scaffold-concept"
|
|
1017
|
+
]
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"id": "tutorial",
|
|
1021
|
+
"label": "Author a tutorial",
|
|
1022
|
+
"when": "The goal is learning with sample data and reset",
|
|
1023
|
+
"rationale": "Tutorials teach; production guides remain usable without them.",
|
|
1024
|
+
"guideIds": []
|
|
1025
|
+
}
|
|
1026
|
+
],
|
|
1027
|
+
"verification": [
|
|
1028
|
+
"Selected type matches the FR selection table"
|
|
1029
|
+
],
|
|
1030
|
+
"recovery": [],
|
|
1031
|
+
"escalation": "If product truth is unclear, stop and ask the product owners — do not infer from source."
|
|
1032
|
+
}
|
|
1033
|
+
],
|
|
1034
|
+
"decisions": [],
|
|
1035
|
+
"glossary": [
|
|
1036
|
+
{
|
|
1037
|
+
"id": "docify",
|
|
1038
|
+
"term": "Docify",
|
|
1039
|
+
"meaning": "x12i framework that turns explicitly authored product knowledge into a website and agent package.",
|
|
1040
|
+
"technicalName": "@x12i/docify",
|
|
1041
|
+
"aliases": [
|
|
1042
|
+
"x12i-docify"
|
|
1043
|
+
],
|
|
1044
|
+
"relatedConceptIds": [
|
|
1045
|
+
"explicit-authoring"
|
|
1046
|
+
],
|
|
1047
|
+
"firstPageId": "explicit-authoring"
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
"id": "search-json",
|
|
1051
|
+
"term": "SEARCH.json",
|
|
1052
|
+
"meaning": "Deterministic local search index over all addressable knowledge items.",
|
|
1053
|
+
"aliases": [
|
|
1054
|
+
"search index"
|
|
1055
|
+
],
|
|
1056
|
+
"relatedConceptIds": [
|
|
1057
|
+
"open-markdown"
|
|
1058
|
+
]
|
|
1059
|
+
}
|
|
1060
|
+
],
|
|
1061
|
+
"visuals": [],
|
|
1062
|
+
"diagrams": [
|
|
1063
|
+
{
|
|
1064
|
+
"id": "docify-dual-audience",
|
|
1065
|
+
"type": "flow",
|
|
1066
|
+
"title": "One library, two consumption surfaces",
|
|
1067
|
+
"summary": "Explicitly authored content becomes a human website and an agent knowledge package.",
|
|
1068
|
+
"why": "Humans and agents share one source model without forked facts.",
|
|
1069
|
+
"direction": "left-to-right",
|
|
1070
|
+
"nodes": [
|
|
1071
|
+
{
|
|
1072
|
+
"id": "authors",
|
|
1073
|
+
"label": "Authors",
|
|
1074
|
+
"description": "Humans or agents write explicit knowledge",
|
|
1075
|
+
"conceptId": "explicit-authoring"
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"id": "validate",
|
|
1079
|
+
"label": "Validate",
|
|
1080
|
+
"description": "Schemas, links, a11y metadata"
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"id": "web",
|
|
1084
|
+
"label": "Website",
|
|
1085
|
+
"description": "Human consumption"
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"id": "agent",
|
|
1089
|
+
"label": "Agent package",
|
|
1090
|
+
"description": "INDEX, SEARCH, Markdown, SDK",
|
|
1091
|
+
"conceptId": "open-markdown"
|
|
1092
|
+
}
|
|
1093
|
+
],
|
|
1094
|
+
"edges": [
|
|
1095
|
+
{
|
|
1096
|
+
"from": "authors",
|
|
1097
|
+
"to": "validate",
|
|
1098
|
+
"label": "declare",
|
|
1099
|
+
"description": "Only declared inputs are processed"
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"from": "validate",
|
|
1103
|
+
"to": "web",
|
|
1104
|
+
"label": "render"
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"from": "validate",
|
|
1108
|
+
"to": "agent",
|
|
1109
|
+
"label": "pack"
|
|
1110
|
+
}
|
|
1111
|
+
],
|
|
1112
|
+
"howToRead": "Follow arrows from authored sources to human and agent outputs.",
|
|
1113
|
+
"keyTakeaways": [
|
|
1114
|
+
"Authors own product truth",
|
|
1115
|
+
"Docify never scans the product repository",
|
|
1116
|
+
"Open Markdown is the agent baseline"
|
|
1117
|
+
],
|
|
1118
|
+
"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.",
|
|
1119
|
+
"mermaid": "flowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n",
|
|
1120
|
+
"audiences": [
|
|
1121
|
+
"developers",
|
|
1122
|
+
"builders"
|
|
1123
|
+
],
|
|
1124
|
+
"related": [
|
|
1125
|
+
"explicit-authoring",
|
|
1126
|
+
"open-markdown"
|
|
1127
|
+
],
|
|
1128
|
+
"tags": [
|
|
1129
|
+
"platform"
|
|
1130
|
+
]
|
|
1131
|
+
}
|
|
1132
|
+
],
|
|
1133
|
+
"relationships": [
|
|
1134
|
+
{
|
|
1135
|
+
"id": "explicit-to-open-md",
|
|
1136
|
+
"type": "prerequisiteOf",
|
|
1137
|
+
"from": "explicit-authoring",
|
|
1138
|
+
"to": "open-markdown",
|
|
1139
|
+
"label": "enables",
|
|
1140
|
+
"description": "Explicit authorship feeds open Markdown packaging"
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"id": "types-related",
|
|
1144
|
+
"type": "relatedTo",
|
|
1145
|
+
"from": "guide-vs-scenario",
|
|
1146
|
+
"to": "explicit-authoring",
|
|
1147
|
+
"description": "Type selection is part of the authoring method"
|
|
1148
|
+
}
|
|
1149
|
+
],
|
|
1150
|
+
"tutorials": [],
|
|
1151
|
+
"examples": [],
|
|
1152
|
+
"sampleData": [],
|
|
1153
|
+
"uiClients": [],
|
|
1154
|
+
"apis": []
|
|
1155
|
+
};
|
|
1156
|
+
export const search = {
|
|
1157
|
+
"version": 1,
|
|
1158
|
+
"product": "docify",
|
|
1159
|
+
"generatedAt": "2026-07-26T10:51:47.660Z",
|
|
1160
|
+
"records": [
|
|
1161
|
+
{
|
|
1162
|
+
"id": "explicit-authoring",
|
|
1163
|
+
"type": "concept",
|
|
1164
|
+
"title": "Explicit authoring",
|
|
1165
|
+
"summary": "Docify only builds knowledge that authors declare — it never discovers product truth from source.",
|
|
1166
|
+
"aliases": [],
|
|
1167
|
+
"audiences": [
|
|
1168
|
+
"developers",
|
|
1169
|
+
"builders"
|
|
1170
|
+
],
|
|
1171
|
+
"tags": [
|
|
1172
|
+
"authoring",
|
|
1173
|
+
"boundary"
|
|
1174
|
+
],
|
|
1175
|
+
"goals": [],
|
|
1176
|
+
"path": "concepts/explicit-authoring.md",
|
|
1177
|
+
"webPath": "/concepts/explicit-authoring",
|
|
1178
|
+
"prerequisites": [],
|
|
1179
|
+
"related": [
|
|
1180
|
+
"open-markdown",
|
|
1181
|
+
"knowledge-relationships"
|
|
1182
|
+
],
|
|
1183
|
+
"packIds": [
|
|
1184
|
+
"concept/explicit-authoring"
|
|
1185
|
+
]
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"id": "open-markdown",
|
|
1189
|
+
"type": "concept",
|
|
1190
|
+
"title": "Open Markdown baseline",
|
|
1191
|
+
"summary": "Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.",
|
|
1192
|
+
"aliases": [],
|
|
1193
|
+
"audiences": [
|
|
1194
|
+
"developers"
|
|
1195
|
+
],
|
|
1196
|
+
"tags": [
|
|
1197
|
+
"agents",
|
|
1198
|
+
"packaging"
|
|
1199
|
+
],
|
|
1200
|
+
"goals": [],
|
|
1201
|
+
"path": "concepts/open-markdown.md",
|
|
1202
|
+
"webPath": "/concepts/open-markdown",
|
|
1203
|
+
"prerequisites": [],
|
|
1204
|
+
"related": [
|
|
1205
|
+
"explicit-authoring"
|
|
1206
|
+
],
|
|
1207
|
+
"packIds": [
|
|
1208
|
+
"concept/open-markdown"
|
|
1209
|
+
]
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"id": "guide-vs-scenario",
|
|
1213
|
+
"type": "concept",
|
|
1214
|
+
"title": "Guides vs scenarios vs journeys",
|
|
1215
|
+
"summary": "Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.",
|
|
1216
|
+
"aliases": [],
|
|
1217
|
+
"audiences": [
|
|
1218
|
+
"developers",
|
|
1219
|
+
"builders"
|
|
1220
|
+
],
|
|
1221
|
+
"tags": [
|
|
1222
|
+
"authoring"
|
|
1223
|
+
],
|
|
1224
|
+
"goals": [],
|
|
1225
|
+
"path": "concepts/guide-vs-scenario.md",
|
|
1226
|
+
"webPath": "/concepts/guide-vs-scenario",
|
|
1227
|
+
"prerequisites": [],
|
|
1228
|
+
"related": [
|
|
1229
|
+
"explicit-authoring"
|
|
1230
|
+
],
|
|
1231
|
+
"packIds": [
|
|
1232
|
+
"concept/guide-vs-scenario"
|
|
1233
|
+
]
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"id": "scaffold-concept",
|
|
1237
|
+
"type": "guide",
|
|
1238
|
+
"title": "Scaffold a concept page",
|
|
1239
|
+
"summary": "Create a validated concept with problem, why, and mental model.",
|
|
1240
|
+
"aliases": [],
|
|
1241
|
+
"audiences": [
|
|
1242
|
+
"developers",
|
|
1243
|
+
"builders"
|
|
1244
|
+
],
|
|
1245
|
+
"tags": [
|
|
1246
|
+
"authoring"
|
|
1247
|
+
],
|
|
1248
|
+
"goals": [],
|
|
1249
|
+
"path": "guides/scaffold-concept.md",
|
|
1250
|
+
"webPath": "/guides/scaffold-concept",
|
|
1251
|
+
"prerequisites": [],
|
|
1252
|
+
"related": [
|
|
1253
|
+
"explicit-authoring"
|
|
1254
|
+
],
|
|
1255
|
+
"packIds": [
|
|
1256
|
+
"guide/scaffold-concept"
|
|
1257
|
+
]
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"id": "choose-content-type",
|
|
1261
|
+
"type": "scenario",
|
|
1262
|
+
"title": "Choose the right Docify content type",
|
|
1263
|
+
"summary": "Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.",
|
|
1264
|
+
"aliases": [],
|
|
1265
|
+
"audiences": [
|
|
1266
|
+
"developers",
|
|
1267
|
+
"builders"
|
|
1268
|
+
],
|
|
1269
|
+
"tags": [],
|
|
1270
|
+
"goals": [
|
|
1271
|
+
"Which Docify content type fits this goal?"
|
|
1272
|
+
],
|
|
1273
|
+
"path": "scenarios/choose-content-type.md",
|
|
1274
|
+
"webPath": "/scenarios/choose-content-type",
|
|
1275
|
+
"prerequisites": [],
|
|
1276
|
+
"related": [],
|
|
1277
|
+
"packIds": [
|
|
1278
|
+
"scenario/choose-content-type"
|
|
1279
|
+
]
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"id": "docify",
|
|
1283
|
+
"type": "glossary",
|
|
1284
|
+
"title": "Docify",
|
|
1285
|
+
"summary": "x12i framework that turns explicitly authored product knowledge into a website and agent package.",
|
|
1286
|
+
"aliases": [
|
|
1287
|
+
"x12i-docify"
|
|
1288
|
+
],
|
|
1289
|
+
"audiences": [],
|
|
1290
|
+
"tags": [],
|
|
1291
|
+
"goals": [],
|
|
1292
|
+
"path": "glossary/docify.md",
|
|
1293
|
+
"prerequisites": [],
|
|
1294
|
+
"related": [
|
|
1295
|
+
"explicit-authoring"
|
|
1296
|
+
],
|
|
1297
|
+
"packIds": []
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"id": "search-json",
|
|
1301
|
+
"type": "glossary",
|
|
1302
|
+
"title": "SEARCH.json",
|
|
1303
|
+
"summary": "Deterministic local search index over all addressable knowledge items.",
|
|
1304
|
+
"aliases": [
|
|
1305
|
+
"search index"
|
|
1306
|
+
],
|
|
1307
|
+
"audiences": [],
|
|
1308
|
+
"tags": [],
|
|
1309
|
+
"goals": [],
|
|
1310
|
+
"path": "glossary/search-json.md",
|
|
1311
|
+
"prerequisites": [],
|
|
1312
|
+
"related": [
|
|
1313
|
+
"open-markdown"
|
|
1314
|
+
],
|
|
1315
|
+
"packIds": []
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
"id": "docify-dual-audience",
|
|
1319
|
+
"type": "diagram",
|
|
1320
|
+
"title": "One library, two consumption surfaces",
|
|
1321
|
+
"summary": "Explicitly authored content becomes a human website and an agent knowledge package.",
|
|
1322
|
+
"aliases": [],
|
|
1323
|
+
"audiences": [
|
|
1324
|
+
"developers",
|
|
1325
|
+
"builders"
|
|
1326
|
+
],
|
|
1327
|
+
"tags": [
|
|
1328
|
+
"platform"
|
|
1329
|
+
],
|
|
1330
|
+
"goals": [],
|
|
1331
|
+
"path": "diagrams/docify-dual-audience.md",
|
|
1332
|
+
"webPath": "/diagrams/docify-dual-audience",
|
|
1333
|
+
"prerequisites": [],
|
|
1334
|
+
"related": [
|
|
1335
|
+
"explicit-authoring",
|
|
1336
|
+
"open-markdown"
|
|
1337
|
+
],
|
|
1338
|
+
"packIds": []
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"id": "orient-docify",
|
|
1342
|
+
"type": "use-case",
|
|
1343
|
+
"title": "Orient on x12i-docify",
|
|
1344
|
+
"summary": "Understand the dual-audience platform and where product libraries fit.",
|
|
1345
|
+
"aliases": [],
|
|
1346
|
+
"audiences": [
|
|
1347
|
+
"developers",
|
|
1348
|
+
"builders"
|
|
1349
|
+
],
|
|
1350
|
+
"tags": [
|
|
1351
|
+
"platform",
|
|
1352
|
+
"start-here"
|
|
1353
|
+
],
|
|
1354
|
+
"goals": [
|
|
1355
|
+
"Understand the dual-audience platform and where product libraries fit."
|
|
1356
|
+
],
|
|
1357
|
+
"path": "use-cases/orient-docify.md",
|
|
1358
|
+
"webPath": "/use-cases#orient-docify",
|
|
1359
|
+
"prerequisites": [],
|
|
1360
|
+
"related": [
|
|
1361
|
+
"00-platform-overview"
|
|
1362
|
+
],
|
|
1363
|
+
"packIds": [
|
|
1364
|
+
"use-case/orient-docify"
|
|
1365
|
+
]
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
"id": "map-packages",
|
|
1369
|
+
"type": "use-case",
|
|
1370
|
+
"title": "Map the @x12i/docify-* packages",
|
|
1371
|
+
"summary": "Know which package owns schemas, theme, render, export, SDK, web, and screenshots.",
|
|
1372
|
+
"aliases": [],
|
|
1373
|
+
"audiences": [
|
|
1374
|
+
"developers"
|
|
1375
|
+
],
|
|
1376
|
+
"tags": [
|
|
1377
|
+
"packages",
|
|
1378
|
+
"npm"
|
|
1379
|
+
],
|
|
1380
|
+
"goals": [
|
|
1381
|
+
"Know which package owns schemas, theme, render, export, SDK, web, and screenshots."
|
|
1382
|
+
],
|
|
1383
|
+
"path": "use-cases/map-packages.md",
|
|
1384
|
+
"webPath": "/use-cases#map-packages",
|
|
1385
|
+
"prerequisites": [],
|
|
1386
|
+
"related": [
|
|
1387
|
+
"01-packages"
|
|
1388
|
+
],
|
|
1389
|
+
"packIds": [
|
|
1390
|
+
"use-case/map-packages"
|
|
1391
|
+
]
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"id": "wire-product-library",
|
|
1395
|
+
"type": "use-case",
|
|
1396
|
+
"title": "Wire a product docs library",
|
|
1397
|
+
"summary": "Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.",
|
|
1398
|
+
"aliases": [],
|
|
1399
|
+
"audiences": [
|
|
1400
|
+
"developers",
|
|
1401
|
+
"builders"
|
|
1402
|
+
],
|
|
1403
|
+
"tags": [
|
|
1404
|
+
"authoring",
|
|
1405
|
+
"getting-started"
|
|
1406
|
+
],
|
|
1407
|
+
"goals": [
|
|
1408
|
+
"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web."
|
|
1409
|
+
],
|
|
1410
|
+
"path": "use-cases/wire-product-library.md",
|
|
1411
|
+
"webPath": "/use-cases#wire-product-library",
|
|
1412
|
+
"prerequisites": [],
|
|
1413
|
+
"related": [
|
|
1414
|
+
"02-authoring",
|
|
1415
|
+
"05-design"
|
|
1416
|
+
],
|
|
1417
|
+
"packIds": [
|
|
1418
|
+
"use-case/wire-product-library"
|
|
1419
|
+
]
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
"id": "ship-human-site",
|
|
1423
|
+
"type": "use-case",
|
|
1424
|
+
"title": "Ship the human web app",
|
|
1425
|
+
"summary": "Build and serve dist/web with roles, use cases, catalog, and chapter reader.",
|
|
1426
|
+
"aliases": [],
|
|
1427
|
+
"audiences": [
|
|
1428
|
+
"developers",
|
|
1429
|
+
"builders"
|
|
1430
|
+
],
|
|
1431
|
+
"tags": [
|
|
1432
|
+
"humans",
|
|
1433
|
+
"web"
|
|
1434
|
+
],
|
|
1435
|
+
"goals": [
|
|
1436
|
+
"Build and serve dist/web with roles, use cases, catalog, and chapter reader."
|
|
1437
|
+
],
|
|
1438
|
+
"path": "use-cases/ship-human-site.md",
|
|
1439
|
+
"webPath": "/use-cases#ship-human-site",
|
|
1440
|
+
"prerequisites": [],
|
|
1441
|
+
"related": [
|
|
1442
|
+
"03-for-humans"
|
|
1443
|
+
],
|
|
1444
|
+
"packIds": [
|
|
1445
|
+
"use-case/ship-human-site"
|
|
1446
|
+
]
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"id": "ship-agent-packs",
|
|
1450
|
+
"type": "use-case",
|
|
1451
|
+
"title": "Ship agent markdown and knowledge SDK",
|
|
1452
|
+
"summary": "Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.",
|
|
1453
|
+
"aliases": [],
|
|
1454
|
+
"audiences": [
|
|
1455
|
+
"developers"
|
|
1456
|
+
],
|
|
1457
|
+
"tags": [
|
|
1458
|
+
"agents",
|
|
1459
|
+
"sdk"
|
|
1460
|
+
],
|
|
1461
|
+
"goals": [
|
|
1462
|
+
"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D."
|
|
1463
|
+
],
|
|
1464
|
+
"path": "use-cases/ship-agent-packs.md",
|
|
1465
|
+
"webPath": "/use-cases#ship-agent-packs",
|
|
1466
|
+
"prerequisites": [],
|
|
1467
|
+
"related": [
|
|
1468
|
+
"04-for-agents"
|
|
1469
|
+
],
|
|
1470
|
+
"packIds": [
|
|
1471
|
+
"use-case/ship-agent-packs"
|
|
1472
|
+
]
|
|
1473
|
+
},
|
|
1474
|
+
{
|
|
1475
|
+
"id": "keep-one-design",
|
|
1476
|
+
"type": "use-case",
|
|
1477
|
+
"title": "Keep one design system",
|
|
1478
|
+
"summary": "Change product naming and content only — never fork theme or invent a competing palette.",
|
|
1479
|
+
"aliases": [],
|
|
1480
|
+
"audiences": [
|
|
1481
|
+
"developers",
|
|
1482
|
+
"builders"
|
|
1483
|
+
],
|
|
1484
|
+
"tags": [
|
|
1485
|
+
"design",
|
|
1486
|
+
"theme"
|
|
1487
|
+
],
|
|
1488
|
+
"goals": [
|
|
1489
|
+
"Change product naming and content only — never fork theme or invent a competing palette."
|
|
1490
|
+
],
|
|
1491
|
+
"path": "use-cases/keep-one-design.md",
|
|
1492
|
+
"webPath": "/use-cases#keep-one-design",
|
|
1493
|
+
"prerequisites": [],
|
|
1494
|
+
"related": [
|
|
1495
|
+
"05-design"
|
|
1496
|
+
],
|
|
1497
|
+
"packIds": [
|
|
1498
|
+
"use-case/keep-one-design"
|
|
1499
|
+
]
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"id": "00-platform-overview",
|
|
1503
|
+
"type": "book",
|
|
1504
|
+
"title": "Platform Overview",
|
|
1505
|
+
"summary": "What x12i-docify is, who it serves, and how product libraries plug in without forking UI.",
|
|
1506
|
+
"aliases": [
|
|
1507
|
+
"CASE FILE · DOC-00"
|
|
1508
|
+
],
|
|
1509
|
+
"audiences": [
|
|
1510
|
+
"developers",
|
|
1511
|
+
"builders"
|
|
1512
|
+
],
|
|
1513
|
+
"tags": [
|
|
1514
|
+
"platform",
|
|
1515
|
+
"start-here",
|
|
1516
|
+
"overview"
|
|
1517
|
+
],
|
|
1518
|
+
"goals": [],
|
|
1519
|
+
"path": "books/00-platform-overview/",
|
|
1520
|
+
"webPath": "/books/00-platform-overview",
|
|
1521
|
+
"prerequisites": [],
|
|
1522
|
+
"related": [],
|
|
1523
|
+
"packIds": []
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"id": "01-packages",
|
|
1527
|
+
"type": "book",
|
|
1528
|
+
"title": "Packages",
|
|
1529
|
+
"summary": "Core, theme, render, export, SDK, web, and screenshots — what each package owns.",
|
|
1530
|
+
"aliases": [
|
|
1531
|
+
"CASE FILE · DOC-01"
|
|
1532
|
+
],
|
|
1533
|
+
"audiences": [
|
|
1534
|
+
"developers"
|
|
1535
|
+
],
|
|
1536
|
+
"tags": [
|
|
1537
|
+
"packages",
|
|
1538
|
+
"npm",
|
|
1539
|
+
"platform"
|
|
1540
|
+
],
|
|
1541
|
+
"goals": [],
|
|
1542
|
+
"path": "books/01-packages/",
|
|
1543
|
+
"webPath": "/books/01-packages",
|
|
1544
|
+
"prerequisites": [],
|
|
1545
|
+
"related": [],
|
|
1546
|
+
"packIds": []
|
|
1547
|
+
},
|
|
1548
|
+
{
|
|
1549
|
+
"id": "02-authoring",
|
|
1550
|
+
"type": "book",
|
|
1551
|
+
"title": "Authoring a Library",
|
|
1552
|
+
"summary": "Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.",
|
|
1553
|
+
"aliases": [
|
|
1554
|
+
"CASE FILE · DOC-02"
|
|
1555
|
+
],
|
|
1556
|
+
"audiences": [
|
|
1557
|
+
"developers",
|
|
1558
|
+
"builders"
|
|
1559
|
+
],
|
|
1560
|
+
"tags": [
|
|
1561
|
+
"authoring",
|
|
1562
|
+
"content",
|
|
1563
|
+
"getting-started"
|
|
1564
|
+
],
|
|
1565
|
+
"goals": [],
|
|
1566
|
+
"path": "books/02-authoring/",
|
|
1567
|
+
"webPath": "/books/02-authoring",
|
|
1568
|
+
"prerequisites": [],
|
|
1569
|
+
"related": [],
|
|
1570
|
+
"packIds": []
|
|
1571
|
+
},
|
|
1572
|
+
{
|
|
1573
|
+
"id": "03-for-humans",
|
|
1574
|
+
"type": "book",
|
|
1575
|
+
"title": "For Humans",
|
|
1576
|
+
"summary": "How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.",
|
|
1577
|
+
"aliases": [
|
|
1578
|
+
"CASE FILE · DOC-03"
|
|
1579
|
+
],
|
|
1580
|
+
"audiences": [
|
|
1581
|
+
"developers",
|
|
1582
|
+
"builders"
|
|
1583
|
+
],
|
|
1584
|
+
"tags": [
|
|
1585
|
+
"humans",
|
|
1586
|
+
"web",
|
|
1587
|
+
"reader"
|
|
1588
|
+
],
|
|
1589
|
+
"goals": [],
|
|
1590
|
+
"path": "books/03-for-humans/",
|
|
1591
|
+
"webPath": "/books/03-for-humans",
|
|
1592
|
+
"prerequisites": [],
|
|
1593
|
+
"related": [],
|
|
1594
|
+
"packIds": []
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"id": "04-for-agents",
|
|
1598
|
+
"type": "book",
|
|
1599
|
+
"title": "For Agents",
|
|
1600
|
+
"summary": "MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.",
|
|
1601
|
+
"aliases": [
|
|
1602
|
+
"CASE FILE · DOC-04"
|
|
1603
|
+
],
|
|
1604
|
+
"audiences": [
|
|
1605
|
+
"developers"
|
|
1606
|
+
],
|
|
1607
|
+
"tags": [
|
|
1608
|
+
"agents",
|
|
1609
|
+
"sdk",
|
|
1610
|
+
"markdown"
|
|
1611
|
+
],
|
|
1612
|
+
"goals": [],
|
|
1613
|
+
"path": "books/04-for-agents/",
|
|
1614
|
+
"webPath": "/books/04-for-agents",
|
|
1615
|
+
"prerequisites": [],
|
|
1616
|
+
"related": [],
|
|
1617
|
+
"packIds": []
|
|
1618
|
+
},
|
|
1619
|
+
{
|
|
1620
|
+
"id": "05-design",
|
|
1621
|
+
"type": "book",
|
|
1622
|
+
"title": "Design System",
|
|
1623
|
+
"summary": "Shared theme tokens and surfaces — products change naming and content only.",
|
|
1624
|
+
"aliases": [
|
|
1625
|
+
"CASE FILE · DOC-05"
|
|
1626
|
+
],
|
|
1627
|
+
"audiences": [
|
|
1628
|
+
"developers",
|
|
1629
|
+
"builders"
|
|
1630
|
+
],
|
|
1631
|
+
"tags": [
|
|
1632
|
+
"design",
|
|
1633
|
+
"theme",
|
|
1634
|
+
"brand"
|
|
1635
|
+
],
|
|
1636
|
+
"goals": [],
|
|
1637
|
+
"path": "books/05-design/",
|
|
1638
|
+
"webPath": "/books/05-design",
|
|
1639
|
+
"prerequisites": [],
|
|
1640
|
+
"related": [],
|
|
1641
|
+
"packIds": []
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"id": "06-getting-started-and-tutorials",
|
|
1645
|
+
"type": "book",
|
|
1646
|
+
"title": "Getting Started & Tutorials",
|
|
1647
|
+
"summary": "Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.",
|
|
1648
|
+
"aliases": [
|
|
1649
|
+
"CASE FILE · DOC-06"
|
|
1650
|
+
],
|
|
1651
|
+
"audiences": [
|
|
1652
|
+
"developers",
|
|
1653
|
+
"builders"
|
|
1654
|
+
],
|
|
1655
|
+
"tags": [
|
|
1656
|
+
"getting-started",
|
|
1657
|
+
"tutorials",
|
|
1658
|
+
"install",
|
|
1659
|
+
"start-here"
|
|
1660
|
+
],
|
|
1661
|
+
"goals": [],
|
|
1662
|
+
"path": "books/06-getting-started-and-tutorials/",
|
|
1663
|
+
"webPath": "/books/06-getting-started-and-tutorials",
|
|
1664
|
+
"prerequisites": [],
|
|
1665
|
+
"related": [],
|
|
1666
|
+
"packIds": []
|
|
1667
|
+
}
|
|
586
1668
|
]
|
|
587
1669
|
};
|
|
588
1670
|
export const files = {
|
|
589
1671
|
"downloads/books/00-platform-overview/builders.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"how-to-read-this-guide\",\n \"title\": \"How to read this guide\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"the-central-idea\",\n \"title\": \"The central idea\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"1-what-you-own\",\n \"title\": \"1. What you own\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"2-layers\",\n \"title\": \"2. Layers\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"3-hard-rules-author-edition\",\n \"title\": \"3. Hard rules (author edition)\",\n \"level\": 2,\n \"order\": 5\n },\n {\n \"slug\": \"4-where-to-go-next\",\n \"title\": \"4. Where to go next\",\n \"level\": 2,\n \"order\": 6\n }\n]",
|
|
590
1672
|
"downloads/books/00-platform-overview/builders.md": "# x12i-docify Platform Overview — Builders\n\n**Audience:** Content authors writing books and site pages for a product docs library. \n**Twin:** [Developers version](../developers/BOOK.md)\n\n---\n\n## How to read this guide\n\nFocus on **what you author** and **what readers see**. Leave package wiring details to the developers twin unless you also own the build scripts.\n\n---\n\n## The central idea\n\nYou write **one library of Markdown**. Docify turns it into:\n\n- a **website** people browse (roles → use cases → chapters),\n- **downloadable books** (MD, and PDF when built),\n- **use-case packs** agents can load without scraping HTML.\n\nYou do **not** design a new theme or web app. You fill content contracts.\n\n---\n\n## 1. What you own\n\n| Artifact | Your job |\n|---|---|\n| `NN-slug/{audience}/BOOK.md` | Chapter bodies (H2 = chapter) |\n| `NN-slug/site-pages/landing.md` | Book landing copy |\n| `site-pages/*.md` | Product home, docs hub, getting started, … |\n| `data/catalog.json` | Roles, families, book metadata |\n| `data/use-cases.json` | Task → book + chapter slugs |\n| `data/site.json` | Brand strings, nav, knowledge package name |\n\n---\n\n## 2. Layers\n\nProduct content lives in a **docs library** folder (for Memorix: `memorix-docs/`; for this platform: this tree under `x12i-docify/`). The platform packages under `packages/docify-*` stay shared.\n\n---\n\n## 3. Hard rules (author edition)\n\n1. Prefer **task-first use cases** over dumping entire books into one path.\n2. Chapter slugs come from **H2 titles** — rename headings carefully; update use cases.\n3. Keep **developers** and **builders** twins in sync on shared facts; diverge only on depth and tone.\n4. Never invent a second visual brand that fights the shared design system.\n\n---\n\n## 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Authoring recipe | [Authoring a Library](../../02-authoring/builders/BOOK.md) |\n| Human navigation | [For Humans](../../03-for-humans/builders/BOOK.md) |\n| Design do / don’t | [Design System](../../05-design/builders/BOOK.md) |\n",
|
|
591
|
-
"downloads/books/00-platform-overview/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"how-to-read-this-guide\",\n \"title\": \"How to read this guide\",\n \"level\": 2,\n \"order\":
|
|
592
|
-
"downloads/books/00-platform-overview/developers.md": "# x12i-docify Platform Overview — Developers\n\n**Audience:** Engineers wiring `@x12i/docify-*` into a monorepo or publishing a product knowledge SDK. \n**Twin:** [Builders version](../builders/BOOK.md) \n**Site:** this library’s web app · platform README at `x12i-docify/README.md`\n\n---\n\n## How to read this guide\n\n1. Start with the **central idea** — one content library, two consumption surfaces.\n2. Use **layers** when deciding platform vs product library responsibilities.\n3. Jump to Packages, Authoring, For Humans, or For Agents for depth.\n\n---\n\n## The central idea\n\n**x12i-docify** is the reusable **product site + docs + knowledge packs** platform for x12i monorepos.\n\n> One content library (`BOOK.md` + use cases). Two consumption surfaces. Same design system everywhere — products change naming and content only.\n\n| Audience | Best form | What we ship |\n|---|---|---|\n| **Humans** | Web app | Product home, docs hub, roles, use cases, catalog, book landings, chapter reader, MD/PDF downloads — `@x12i/docify-web` |\n| **AI agents** | Markdown + packages | Per-book MD, use-case packs, chapter indexes, `agent-manifest.json`, `@x12i/docify-sdk` / product `@…-docs` |\n\nKnowledge SDKs are **devDependencies** — documentation for tools and agents, not a production runtime.\n\n---\n\n## 1. What x12i-docify is\n\n### The problem it solves\n\nEvery product monorepo needs:\n\n- a branded docs **site** humans can browse,\n- **ebooks** with stable chapter structure,\n- **task-first use cases** that deep-link into chapters,\n- **agent-friendly** Markdown packs and a discoverable manifest,\n- one **visual system** so products do not invent competing UIs.\n\nDocify answers that with shared packages. Product folders supply content and brand strings only.\n\n### Who uses what\n\n| You are… | Primary surface | Install |\n|---|---|---|\n| Reader (human) | Product `dist/web` | Nothing — open the site |\n| Content author | `BOOK.md` + `site-pages` + `data/*.json` | Platform packages in the monorepo |\n| Integrator / platform engineer | `@x12i/docify-*` | Platform packages; optional product `@…-docs` as `devDependency` |\n| AI agent / tooling | MD downloads + knowledge SDK | `npm i -D @your-scope/<product>-docs` |\n\n---\n\n## 2. Layers\n\n```mermaid\nflowchart TB\n Platform[x12i-docify platform packages]\n Product[\"<product>-docs content library\"]\n Web[dist/web for humans]\n SDK[\"@…-docs knowledge package\"]\n Product --> Platform\n Product --> Web\n Product --> SDK\n```\n\n| Layer | What it is |\n|---|---|\n| `x12i-docify` | Shared platform (theme, render, web, export, SDK, screenshots) |\n| `<product>-docs/` | Product content: books, site-pages, catalog, use cases |\n| `@x12i/<product>-docs` | Knowledge SDK + MD packs for agents (`npm i -D`) |\n\nMemorix is the large reference implementation: `memorix-docs/` → `@x12i/memorix-docs`. \n**This library** is the platform documenting itself (dogfood).\n\n---\n\n## 3. Hard rules\n\n1. **Do not fork** `@x12i/docify-theme` or `@x12i/docify-web` per product.\n2. Knowledge packages are **devDependencies**, never production UI runtime.\n3. Markdown (`BOOK.md`) is the **source of truth**; HTML/PDF are derived.\n4. Use-case paths must reference **real chapter slugs** (H2 headings).\n5. Site pages use **YAML front-matter**; the platform renders HTML.\n\n---\n\n## 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Package map | [Packages](../../01-packages/developers/BOOK.md) |\n| Wire a new library | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Human site behavior | [For Humans](../../03-for-humans/developers/BOOK.md) |\n| Agent / SDK path | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Theme contract | [Design System](../../05-design/developers/BOOK.md) |\n",
|
|
1673
|
+
"downloads/books/00-platform-overview/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"install-start-here\",\n \"title\": \"Install (start here)\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"how-to-read-this-guide\",\n \"title\": \"How to read this guide\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"the-central-idea\",\n \"title\": \"The central idea\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"1-what-x12i-docify-is\",\n \"title\": \"1. What x12i-docify is\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"2-layers\",\n \"title\": \"2. Layers\",\n \"level\": 2,\n \"order\": 5\n },\n {\n \"slug\": \"3-hard-rules\",\n \"title\": \"3. Hard rules\",\n \"level\": 2,\n \"order\": 6\n },\n {\n \"slug\": \"4-where-to-go-next\",\n \"title\": \"4. Where to go next\",\n \"level\": 2,\n \"order\": 7\n }\n]",
|
|
1674
|
+
"downloads/books/00-platform-overview/developers.md": "# x12i-docify Platform Overview — Developers\n\n**Audience:** Engineers wiring `@x12i/docify-*` into a monorepo or publishing a product knowledge SDK. \n**Twin:** [Builders version](../builders/BOOK.md) \n**Site:** this library’s web app · platform README at `x12i-docify/README.md`\n\n---\n\n## Install (start here)\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs knowledge SDK\nnpm i -D @x12i/memorix-docs # product example (Memorix)\nnpm i @x12i/docify-core @x12i/docify-theme @x12i/docify-render \\\n @x12i/docify-export @x12i/docify-sdk @x12i/docify-web\n```\n\nKnowledge packages (`@x12i/docify`, `@x12i/<product>-docs`) are **devDependencies** only.\n\n---\n\n## How to read this guide\n\n1. Start with **install** above, then the **central idea** — one content library, two consumption surfaces.\n2. Use **layers** when deciding platform vs product library responsibilities.\n3. Jump to Packages, Authoring, For Humans, or For Agents for depth.\n\n---\n\n## The central idea\n\n**x12i-docify** is the reusable **product site + docs + knowledge packs** platform for x12i monorepos.\n\n> One content library (`BOOK.md` + use cases). Two consumption surfaces. Same design system everywhere — products change naming and content only.\n\n| Audience | Best form | What we ship |\n|---|---|---|\n| **Humans** | Web app | Product home, docs hub, roles, use cases, catalog, book landings, chapter reader, MD/PDF downloads — `@x12i/docify-web` |\n| **AI agents** | Markdown + packages | Per-book MD, use-case packs, chapter indexes, `agent-manifest.json`, `@x12i/docify-sdk` / product `@…-docs` |\n\nKnowledge SDKs are **devDependencies** — documentation for tools and agents, not a production runtime.\n\n---\n\n## 1. What x12i-docify is\n\n### The problem it solves\n\nEvery product monorepo needs:\n\n- a branded docs **site** humans can browse,\n- **ebooks** with stable chapter structure,\n- **task-first use cases** that deep-link into chapters,\n- **agent-friendly** Markdown packs and a discoverable manifest,\n- one **visual system** so products do not invent competing UIs.\n\nDocify answers that with shared packages. Product folders supply content and brand strings only.\n\n### Who uses what\n\n| You are… | Primary surface | Install |\n|---|---|---|\n| Reader (human) | Product `dist/web` | Nothing — open the site |\n| Content author | `BOOK.md` + `site-pages` + `data/*.json` | Platform packages in the monorepo |\n| Integrator / platform engineer | `@x12i/docify-*` | Platform packages; optional product `@…-docs` as `devDependency` |\n| AI agent / tooling | MD downloads + knowledge SDK | `npm i -D @your-scope/<product>-docs` |\n\n---\n\n## 2. Layers\n\n```mermaid\nflowchart TB\n Platform[x12i-docify platform packages]\n Product[\"<product>-docs content library\"]\n Web[dist/web for humans]\n SDK[\"@…-docs knowledge package\"]\n Product --> Platform\n Product --> Web\n Product --> SDK\n```\n\n| Layer | What it is |\n|---|---|\n| `x12i-docify` | Shared platform (theme, render, web, export, SDK, screenshots) |\n| `<product>-docs/` | Product content: books, site-pages, catalog, use cases |\n| `@x12i/<product>-docs` | Knowledge SDK + MD packs for agents (`npm i -D`) |\n\nMemorix is the large reference implementation: `memorix-docs/` → `@x12i/memorix-docs`. \n**This library** is the platform documenting itself (dogfood).\n\n---\n\n## 3. Hard rules\n\n1. **Do not fork** `@x12i/docify-theme` or `@x12i/docify-web` per product.\n2. Knowledge packages are **devDependencies**, never production UI runtime.\n3. Markdown (`BOOK.md`) is the **source of truth**; HTML/PDF are derived.\n4. Use-case paths must reference **real chapter slugs** (H2 headings).\n5. Site pages use **YAML front-matter**; the platform renders HTML.\n\n---\n\n## 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Package map | [Packages](../../01-packages/developers/BOOK.md) |\n| Wire a new library | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Human site behavior | [For Humans](../../03-for-humans/developers/BOOK.md) |\n| Agent / SDK path | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Theme contract | [Design System](../../05-design/developers/BOOK.md) |\n",
|
|
593
1675
|
"downloads/books/01-packages/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-package-table\",\n \"title\": \"1. Package table\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-dependency-shape\",\n \"title\": \"2. Dependency shape\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-publish-and-install\",\n \"title\": \"3. Publish and install\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-migration-names\",\n \"title\": \"4. Migration names\",\n \"level\": 2,\n \"order\": 4\n }\n]",
|
|
594
1676
|
"downloads/books/01-packages/developers.md": "# Packages — Developers\n\n**Audience:** Engineers choosing and wiring `@x12i/docify-*` packages. \n**Related:** [Platform Overview](../../00-platform-overview/developers/BOOK.md) · [Authoring](../../02-authoring/developers/BOOK.md)\n\n---\n\n## 1. Package table\n\n| Folder | npm | Role |\n|---|---|---|\n| `docify-core` | `@x12i/docify-core` | Catalog / use-case / site-page / manifest schemas + loaders |\n| `docify-theme` | `@x12i/docify-theme` | Shared site + reader CSS (tokens, site, book, extras) |\n| `docify-render` | `@x12i/docify-render` | `BOOK.md` + site-pages → HTML; chapter extract / splice |\n| `docify-export` | `@x12i/docify-export` | Content bundle builder (downloads, landings, agent-manifest) |\n| `docify-sdk` | `@x12i/docify-sdk` | `createEbooksSdk(bundle)` knowledge SDK factory |\n| `docify-web` | `@x12i/docify-web` | Shareable static web app + `docify-web serve` |\n| `docify-screenshots` | `@x12i/docify-screenshots` | Shot lists, placeholders, capture helpers |\n| `docify` | `@x12i/docify` | Platform docs knowledge SDK (dogfood — docs of docify itself) |\n\n---\n\n## 2. Dependency shape\n\n```mermaid\nflowchart LR\n Core[docify-core]\n Theme[docify-theme]\n Render[docify-render]\n Export[docify-export]\n Sdk[docify-sdk]\n Web[docify-web]\n Shots[docify-screenshots]\n Dogfood[\"@x12i/docify\"]\n Render --> Core\n Export --> Core\n Export --> Render\n Sdk --> Core\n Web --> Theme\n ProductDocs[product-docs build] --> Export\n ProductDocs --> Web\n ProductSdk[\"@…-docs\"] --> Sdk\n Dogfood --> Sdk\n```\n\n- **Humans** consume `docify-web` + theme assets from the assembled `dist/web`.\n- **Agents** consume MD packs from the bundle and/or a published product knowledge SDK built on `docify-sdk`.\n- **`@x12i/docify`** is this platform’s own knowledge SDK (docs of docify).\n\n---\n\n## 3. Publish and install\n\nFrom the monorepo (uses root `.npmrc`):\n\n```bash\nbash scripts/publish-docify.sh\n```\n\nTypical product install:\n\n```bash\nnpm i @x12i/docify-core @x12i/docify-theme @x12i/docify-render \\\n @x12i/docify-export @x12i/docify-sdk @x12i/docify-web\nnpm i -D @x12i/docify # this platform’s docs knowledge SDK\nnpm i -D @x12i/memorix-docs # example product knowledge SDK\n```\n\nIn this monorepo, product builds usually **import from source** under `x12i-docify/packages/*/dist` rather than resolving published tarballs during local `npm run docs`.\n\n---\n\n## 4. Migration names\n\n| Old | New |\n|---|---|\n| `@x12i/ebooks-*` | `@x12i/docify-*` |\n| `x12i-ebooks/` | `x12i-docify/` |\n| `ebooks-web` CLI | `docify-web` |\n| `@x12i/memorix-ebooks` | `@x12i/memorix-docs` |\n",
|
|
595
1677
|
"downloads/books/02-authoring/builders.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-recipe-content-side\",\n \"title\": \"1. Recipe (content side)\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-content-layout\",\n \"title\": \"2. Content layout\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-data-contracts-what-you-edit\",\n \"title\": \"3. Data contracts (what you edit)\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-build-pipeline-preview\",\n \"title\": \"4. Build pipeline (preview)\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"5-writing-tips\",\n \"title\": \"5. Writing tips\",\n \"level\": 2,\n \"order\": 5\n }\n]",
|
|
@@ -601,20 +1683,108 @@ export const files = {
|
|
|
601
1683
|
"downloads/books/03-for-humans/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-best-form-for-humans\",\n \"title\": \"1. Best form for humans\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-typical-flow\",\n \"title\": \"2. Typical flow\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-what-the-bundle-emits\",\n \"title\": \"3. What the bundle emits\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-product-libraries\",\n \"title\": \"4. Product libraries\",\n \"level\": 2,\n \"order\": 4\n }\n]",
|
|
602
1684
|
"downloads/books/03-for-humans/developers.md": "# For Humans — Developers\n\n**Audience:** Engineers shipping `dist/web` for human readers. \n**Twin:** [Builders version](../builders/BOOK.md)\n\n---\n\n## 1. Best form for humans\n\nThe **web app** (`@x12i/docify-web`) is the human surface: case-file UI, role chooser, use-case routing, chapter reader, and download buttons.\n\nHumans should not be asked to scrape Markdown repos as their primary path. Deploy the static tree.\n\n---\n\n## 2. Typical flow\n\n1. **Role** — pick developers / builders (or product-defined roles)\n2. **Use cases** — task-first entry; opens the right book + chapter\n3. **Catalog** — browse books by family\n4. **Reader** — chapter HTML in the shared book theme\n5. **Downloads** — MD (and PDF when built) for offline reading\n\nProduct home (`/`) and docs hub (`/docs`) are authored as site-pages with YAML front-matter.\n\n---\n\n## 3. What the bundle emits\n\n| Path | Role |\n|---|---|\n| `index.html`, `docs.html`, … | Marketing / docs chrome from site-pages |\n| `books/<id>.html` | Book landings |\n| `read.html` + chapter HTML | Reader shell |\n| `catalog.json`, `use-cases.json`, `site.json` | Client data |\n| `downloads/` | MD / PDF / chapter indexes |\n| `agent-manifest.json` | Also useful for humans’ tooling links |\n\nAssemble with `buildContentBundle`, then overlay `docify-web/public` runtime assets (`app.js`, `read.html`, `agents.html`).\n\n---\n\n## 4. Product libraries\n\nEach monorepo ships its own library (e.g. Memorix at `memorix-docs/`) with brand strings and books. The platform does not fork a separate UI per product.\n",
|
|
603
1685
|
"downloads/books/04-for-agents/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-best-form-for-agents\",\n \"title\": \"1. Best form for agents\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-discovery\",\n \"title\": \"2. Discovery\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-knowledge-sdk\",\n \"title\": \"3. Knowledge SDK\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-install-contract\",\n \"title\": \"4. Install contract\",\n \"level\": 2,\n \"order\": 4\n }\n]",
|
|
604
|
-
"downloads/books/04-for-agents/developers.md": "# For Agents — Developers\n\n**Audience:** Engineers shipping agent-consumable knowledge. \n**Related:** [Packages](../../01-packages/developers/BOOK.md) · [Authoring](../../02-authoring/developers/BOOK.md)\n\n---\n\n## 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n",
|
|
1686
|
+
"downloads/books/04-for-agents/developers.md": "# For Agents — Developers\n\n**Audience:** Engineers shipping agent-consumable knowledge. \n**Related:** [Packages](../../01-packages/developers/BOOK.md) · [Authoring](../../02-authoring/developers/BOOK.md)\n\n---\n\n## 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n\nStart-here version with the full why/when: [Getting Started & Tutorials — Installation for agents](../../06-getting-started-and-tutorials/developers/BOOK.md).\n",
|
|
605
1687
|
"downloads/books/05-design/builders.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-principle\",\n \"title\": \"1. Principle\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-identity\",\n \"title\": \"2. Identity\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-surfaces\",\n \"title\": \"3. Surfaces\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-do-not\",\n \"title\": \"4. Do not\",\n \"level\": 2,\n \"order\": 4\n }\n]",
|
|
606
1688
|
"downloads/books/05-design/builders.md": "# Design System — Builders\n\n**Audience:** Authors staying inside the shared visual system. \n**Twin:** [Developers version](../developers/BOOK.md)\n\n---\n\n## 1. Principle\n\n**One design system.** You change **words, books, and brand strings** — not layout, cards chrome, or a new palette.\n\n---\n\n## 2. Identity\n\nThe site already carries IBM Plex, neutral surfaces, and a primary + builders accent. Catalog **book colors** are case-file accents inside that system, not a free-for-all.\n\n---\n\n## 3. Surfaces\n\n| Surface | What you influence |\n|---|---|\n| Product / docs chrome | Site-page copy, CTAs, featured book ids |\n| Chapter reader | Markdown structure and diagrams inside books |\n| Catalog cards | Title, blurb, kicker, color field in `catalog.json` |\n\n---\n\n## 4. Do not\n\n- Ask engineering to fork theme CSS “just for this product”\n- Overload the first viewport with secondary marketing blocks (follow product-home patterns)\n- Treat screenshots as decoration without a shot-list purpose\n",
|
|
607
1689
|
"downloads/books/05-design/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-principle\",\n \"title\": \"1. Principle\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-identity\",\n \"title\": \"2. Identity\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-surfaces\",\n \"title\": \"3. Surfaces\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-do-not\",\n \"title\": \"4. Do not\",\n \"level\": 2,\n \"order\": 4\n }\n]",
|
|
608
1690
|
"downloads/books/05-design/developers.md": "# Design System — Developers\n\n**Audience:** Engineers integrating theme assets into a product build. \n**Twin:** [Builders version](../builders/BOOK.md)\n\n---\n\n## 1. Principle\n\n**One design system.** Product libraries change **naming and content only** — not layout, palette, or component chrome.\n\nWire CSS from `@x12i/docify-theme` (or the monorepo `packages/docify-theme` path) into the content bundle. Do not copy-fork stylesheets into the product folder.\n\n---\n\n## 2. Identity\n\n- IBM Plex Sans / Mono\n- Neutral near-white surface, single blue accent + warm builders accent (`--accent`, `--accent-alt`)\n- Site chrome for product home, docs hub, catalog, use cases\n- Book bodies for chapter reading (screen-tuned; print stays PDF-safe)\n\nProduct `data/site.json` may set `accent` / `accentAlt` CSS colors within the shared system — not a second brand language.\n\n---\n\n## 3. Surfaces\n\n| Surface | Stylesheet | Notes |\n|---|---|---|\n| Web app shell | `site.css`, `extras.css` | Product/docs chrome |\n| Chapter reader | `book.css` | Screen column + print rules |\n| Tokens | `tokens.css` | Shared variables |\n\n---\n\n## 4. Do not\n\n- Fork a second theme per product\n- Invent a new brand palette that fights the shared system\n- Treat the knowledge SDK as a production UI dependency\n- Hand-author HTML for marketing routes — use site-page Markdown + front-matter\n",
|
|
1691
|
+
"downloads/books/06-getting-started-and-tutorials/builders.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-installation-for-agents\",\n \"title\": \"1. Installation for agents\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-getting-started\",\n \"title\": \"2. Getting started\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-best-practice-authoring-order\",\n \"title\": \"3. Best practice — authoring order\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-tutorial-run-the-docs-site\",\n \"title\": \"4. Tutorial — run the docs site\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"5-tutorial-author-a-book\",\n \"title\": \"5. Tutorial — author a book\",\n \"level\": 2,\n \"order\": 5\n },\n {\n \"slug\": \"6-tutorial-publish-the-knowledge-package\",\n \"title\": \"6. Tutorial — publish the knowledge package\",\n \"level\": 2,\n \"order\": 6\n },\n {\n \"slug\": \"7-where-to-go-next\",\n \"title\": \"7. Where to go next\",\n \"level\": 2,\n \"order\": 7\n }\n]",
|
|
1692
|
+
"downloads/books/06-getting-started-and-tutorials/builders.md": "# Getting Started & Tutorials — Builders\n\n**Audience:** Content authors starting a docs library — what to write, in what order, and how readers and agents consume it.\n**Twin:** [Developers version](../developers/BOOK.md)\n**Related:** [Platform Overview](../../00-platform-overview/builders/BOOK.md) · [Authoring](../../02-authoring/builders/BOOK.md) · [For Humans](../../03-for-humans/builders/BOOK.md)\n\n---\n\n## 1. Installation for agents\n\nYou write one library; two audiences consume it:\n\n| Audience | Form | Their “install” |\n|---|---|---|\n| **Humans** | The website (`dist/web`) | None — they browse |\n| **AI agents & tooling** | The knowledge package | `npm i -D @…-docs` |\n\nWhy the package matters to you as an author:\n\n- Everything you write in `BOOK.md` ships **verbatim** to agents as Markdown — clear chapter titles and stable structure directly improve agent answers.\n- Use-case packs are assembled from **your chapter slugs** — renaming an H2 silently changes a slug, so treat headings as contracts.\n- The package is a **devDependency only**: documentation for tools, never product runtime. If someone asks to “import the docs in production,” the answer is no.\n\nYou do not publish the package yourself — engineering does — but your content is what’s inside.\n\n---\n\n## 2. Getting started\n\nPreview loop while writing:\n\n```bash\ncd x12i-docify\nnpm run docs # serve the built site locally (port 4174)\n```\n\nYou mostly live in:\n\n- book folders — `NN-slug/{developers,builders}/BOOK.md`, landings, diagrams, screenshots,\n- top-level `site-pages/*.md`,\n- `data/catalog.json`, `data/use-cases.json`, `data/sequences.json`.\n\nLeave package wiring and `dist/` assembly to developers unless you like running builds.\n\n---\n\n## 3. Best practice — authoring order\n\nWrite in this order — it prevents dead links and rework:\n\n1. **Name the books** in `data/catalog.json` first (even as `coming-soon`).\n2. **Write chapters** with clear, stable `##` titles — every H2 becomes an anchor others link to.\n3. **Landing per book** — one lead sentence, prerequisites, related books.\n4. **Use cases after chapters exist** — each path step needs real chapter slugs.\n5. **Journey last** — the ordered path across books only works when the chapters it points at are written.\n6. **Site pages** — update home / getting started copy when the story changes.\n7. **Preview** — `npm run docs`; the build refuses unknown books and chapter slugs, which protects you.\n\nOne idea per chapter. If a chapter needs three headlines, it is three chapters.\n\n---\n\n## 4. Tutorial — run the docs site\n\n1. Ask a developer (or run yourself): `cd x12i-docify && npm run docs`.\n2. Walk the reader path: docs home → getting started → journey → a book landing → chapters.\n3. Confirm your latest text is there; if not, `npm run docs:rebuild`.\n4. Check your chapter titles read well in the sidebar — that list is generated from your H2s.\n\n---\n\n## 5. Tutorial — author a book\n\n1. Draft `NN-slug/builders/BOOK.md` (and coordinate the developers twin so H2 titles match — shared slugs keep journey links working for both).\n2. Add the landing (`site-pages/landing.md`) with a one-sentence lead.\n3. Register in `data/catalog.json` — kicker, title, blurb, color.\n4. Add at least one use case that deep-links into your chapters.\n5. Preview and click every link you created.\n\n---\n\n## 6. Tutorial — publish the knowledge package\n\nYour part of the publish story:\n\n1. Confirm chapter titles are final — slugs freeze into agent packs and prompts.\n2. Confirm use cases and the journey point at the right chapters.\n3. Hand off to engineering (`npm run build:docs` + publish script).\n4. After publish, agents installing `npm i -D @…-docs` read exactly what you wrote.\n\n---\n\n## 7. Where to go next\n\n| Need | Book |\n|---|---|\n| Platform mental model | [Platform Overview](../../00-platform-overview/builders/BOOK.md) |\n| Authoring contract in depth | [Authoring a Library](../../02-authoring/builders/BOOK.md) |\n| Reader navigation | [For Humans](../../03-for-humans/builders/BOOK.md) |\n| Visual rules | [Design System](../../05-design/builders/BOOK.md) |\n\nOr take the interactive path: open **/journey** on the docs site.\n",
|
|
1693
|
+
"downloads/books/06-getting-started-and-tutorials/developers.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"1-installation-for-agents\",\n \"title\": \"1. Installation for agents\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"2-getting-started\",\n \"title\": \"2. Getting started\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"3-best-practice-authoring-order\",\n \"title\": \"3. Best practice — authoring order\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"4-tutorial-run-the-docs-site\",\n \"title\": \"4. Tutorial — run the docs site\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"5-tutorial-author-a-book\",\n \"title\": \"5. Tutorial — author a book\",\n \"level\": 2,\n \"order\": 5\n },\n {\n \"slug\": \"6-tutorial-publish-the-knowledge-package\",\n \"title\": \"6. Tutorial — publish the knowledge package\",\n \"level\": 2,\n \"order\": 6\n },\n {\n \"slug\": \"7-where-to-go-next\",\n \"title\": \"7. Where to go next\",\n \"level\": 2,\n \"order\": 7\n }\n]",
|
|
1694
|
+
"downloads/books/06-getting-started-and-tutorials/developers.md": "# Getting Started & Tutorials — Developers\n\n**Audience:** Engineers adopting docify in a monorepo — from first install to a published knowledge package.\n**Twin:** [Builders version](../builders/BOOK.md)\n**Related:** [Platform Overview](../../00-platform-overview/developers/BOOK.md) · [Authoring](../../02-authoring/developers/BOOK.md) · [For Agents](../../04-for-agents/developers/BOOK.md)\n\n---\n\n## 1. Installation for agents\n\nThe single most useful thing you can do for AI tooling in your monorepo is install the docs **knowledge package** as a devDependency:\n\n```bash\nnpm i -D @x12i/docify # docs of the docify platform itself\nnpm i -D @x12i/<product>-docs # docs of your product (e.g. @x12i/memorix-docs)\n```\n\n### Why install it\n\n- **Versioned product truth for agents.** Cursor / Codex / CI agents get a pinned, updatable knowledge surface instead of stale prompts or scraped HTML.\n- **Structured Markdown, not web pages.** The package ships per-book MD, chapter indexes (`.chapters.json`), use-case packs, and `agent-manifest.json`.\n- **Typed discovery.** `listUseCases`, `getBookMarkdown`, `getUseCaseMarkdown` answer “which book / chapter?” without hallucinated paths.\n- **Knowledge stays out of prompts.** Product truth lives in a package you upgrade like any dependency.\n\n### Who needs what\n\n| You are… | Install |\n|---|---|\n| Human reading docs | Nothing — use the website |\n| AI agent / tooling / CI | `npm i -D @…-docs` (knowledge package) |\n| Engineer wiring a docs library | `npm i @x12i/docify-{core,theme,render,export,sdk,web}` |\n\n### The devDependency rule\n\nKnowledge packages are **documentation for tools** — never a production runtime.\n\n- Do: `devDependencies`, pinned or caret versions, wired into agent rules/skills.\n- Do not: put `@…-docs` in `dependencies`, import it from shipped product code, or fork its content.\n\nPoint your agent at the package after install — e.g. a repo rule like “consult `@x12i/<product>-docs` (`node_modules/@x12i/<product>-docs`) before answering product questions.”\n\n---\n\n## 2. Getting started\n\nThe fastest working loop on this dogfood library:\n\n```bash\ncd x12i-docify\nnpm run docs # build if needed, serve, open browser (port 4174)\nnpm run docs:rebuild # force rebuild\nnpm test # platform package tests\n```\n\nWhat you are looking at:\n\n| Path | Role |\n|---|---|\n| `packages/docify-*` | Platform (schemas, theme, render, export, SDK, web) |\n| `NN-slug/{audience}/BOOK.md` | Ebooks (H2 = chapter) |\n| `site-pages/*.md` | YAML front-matter site pages |\n| `data/{catalog,use-cases,sequences,site}.json` | Catalog, tasks, journey, chrome |\n| `dist/web` | The built human site |\n\nFor a product library (e.g. `memorix-docs/`), the same layout applies — it depends on the platform packages and never forks theme or web UI.\n\n---\n\n## 3. Best practice — authoring order\n\nBuild a docs library in this order. Each step feeds the next; skipping ahead produces broken links and orphan pages.\n\n1. **Site identity** — `data/site.json`: product, brand, `knowledgePackage`, accents.\n2. **Catalog skeleton** — `data/catalog.json`: roles, family, book ids + dirs (books may start `coming-soon`).\n3. **Books** — `NN-slug/{developers,builders}/BOOK.md` with clear `##` chapter titles (slugs come from them).\n4. **Landings** — `NN-slug/site-pages/landing.md` per book.\n5. **Use cases** — `data/use-cases.json`: task → book + real chapter slugs.\n6. **Journey** — `data/sequences.json`: the ordered start-to-finish path, required vs optional steps.\n7. **Site pages** — home, getting started, journey, catalog, use cases.\n8. **Build + validate** — `npm run docs:rebuild`; the bundle fails on unknown books or chapter slugs.\n9. **Publish** — web tree for humans, `@…-docs` for agents.\n\nThe rule of thumb mirrors the platform’s own pipeline story: declare **nouns** (books, chapters) before **paths** (use cases, journey) before **surfaces** (site pages).\n\n---\n\n## 4. Tutorial — run the docs site\n\nGoal: see the dogfood site served locally.\n\n1. `cd x12i-docify && npm run build` — compile platform packages.\n2. `npm run docs` — builds the content bundle into `dist/bundle`, assembles `dist/web`, serves on port 4174.\n3. Open `/docs`, `/getting-started`, `/journey`, `/catalog` and one book landing.\n4. Check `/agent-manifest.json` and `/sequences.json` — those are the agent-facing artifacts.\n\nIf a page 404s, the bundle didn’t emit it — rerun `npm run docs:rebuild` and read the build error; it names the missing book/chapter.\n\n---\n\n## 5. Tutorial — author a book\n\nGoal: add one book and see it everywhere.\n\n1. Create `NN-slug/developers/BOOK.md` (and `builders/` if dual-audience). Every `##` becomes a chapter slug.\n2. Add `NN-slug/site-pages/landing.md` (`page: book-landing`, `bookId`).\n3. Register the book in `data/catalog.json` (id, audiences, kicker, title, blurb, color, dir).\n4. Reference it from `data/use-cases.json` and, if it belongs on the path, `data/sequences.json` — use exact chapter slugs.\n5. `npm run docs:rebuild` — validation fails loudly on wrong ids or slugs.\n6. Verify: catalog row, landing page, reader chapters, MD download.\n\n---\n\n## 6. Tutorial — publish the knowledge package\n\nGoal: ship `@…-docs` so agents can install it.\n\n1. `npm run build:docs` — regenerates the content bundle and the generated `src/generated/bundle.ts` of the knowledge package.\n2. `npm test` — the knowledge package tests assert books/use cases resolve.\n3. Publish from the monorepo (see `scripts/publish-docify.sh` at repo root).\n4. Consumers install with `npm i -D @…-docs` and wire it into their agents (chapter 1).\n\n---\n\n## 7. Where to go next\n\n| Need | Book |\n|---|---|\n| Platform map | [Platform Overview](../../00-platform-overview/developers/BOOK.md) |\n| Package responsibilities | [Packages](../../01-packages/developers/BOOK.md) |\n| Full authoring contract | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Agent artifacts in depth | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Visual rules | [Design System](../../05-design/developers/BOOK.md) |\n\nOr take the interactive path: open **/journey** on the docs site.\n",
|
|
609
1695
|
"downloads/use-cases/keep-one-design.md": "# Keep one design system\n\n> **Use case id:** `keep-one-design`\n> **Goal:** Change product naming and content only — never fork theme or invent a competing palette.\n> **Audiences:** developers, builders\n> **Tags:** design, theme\n\n## Reading path\n\n1. **Design System** (builders) → chapters: `1-principle`, `2-identity`, `3-surfaces`, `4-do-not`\n\n## From: Design System — 1. Principle\n\n**One design system.** You change **words, books, and brand strings** — not layout, cards chrome, or a new palette.\n\n---\n\n## From: Design System — 2. Identity\n\nThe site already carries IBM Plex, neutral surfaces, and a primary + builders accent. Catalog **book colors** are case-file accents inside that system, not a free-for-all.\n\n---\n\n## From: Design System — 3. Surfaces\n\n| Surface | What you influence |\n|---|---|\n| Product / docs chrome | Site-page copy, CTAs, featured book ids |\n| Chapter reader | Markdown structure and diagrams inside books |\n| Catalog cards | Title, blurb, kicker, color field in `catalog.json` |\n\n---\n\n## From: Design System — 4. Do not\n\n- Ask engineering to fork theme CSS “just for this product”\n- Overload the first viewport with secondary marketing blocks (follow product-home patterns)\n- Treat screenshots as decoration without a shot-list purpose\n\n## Also see\n\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
610
1696
|
"downloads/use-cases/map-packages.md": "# Map the @x12i/docify-* packages\n\n> **Use case id:** `map-packages`\n> **Goal:** Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\n> **Audiences:** developers\n> **Tags:** packages, npm\n\n## Reading path\n\n1. **Packages** (developers) → chapters: `1-package-table`, `2-dependency-shape`, `3-publish-and-install`\n\n## From: Packages — 1. Package table\n\n| Folder | npm | Role |\n|---|---|---|\n| `docify-core` | `@x12i/docify-core` | Catalog / use-case / site-page / manifest schemas + loaders |\n| `docify-theme` | `@x12i/docify-theme` | Shared site + reader CSS (tokens, site, book, extras) |\n| `docify-render` | `@x12i/docify-render` | `BOOK.md` + site-pages → HTML; chapter extract / splice |\n| `docify-export` | `@x12i/docify-export` | Content bundle builder (downloads, landings, agent-manifest) |\n| `docify-sdk` | `@x12i/docify-sdk` | `createEbooksSdk(bundle)` knowledge SDK factory |\n| `docify-web` | `@x12i/docify-web` | Shareable static web app + `docify-web serve` |\n| `docify-screenshots` | `@x12i/docify-screenshots` | Shot lists, placeholders, capture helpers |\n| `docify` | `@x12i/docify` | Platform docs knowledge SDK (dogfood — docs of docify itself) |\n\n---\n\n## From: Packages — 2. Dependency shape\n\n```mermaid\nflowchart LR\n Core[docify-core]\n Theme[docify-theme]\n Render[docify-render]\n Export[docify-export]\n Sdk[docify-sdk]\n Web[docify-web]\n Shots[docify-screenshots]\n Dogfood[\"@x12i/docify\"]\n Render --> Core\n Export --> Core\n Export --> Render\n Sdk --> Core\n Web --> Theme\n ProductDocs[product-docs build] --> Export\n ProductDocs --> Web\n ProductSdk[\"@…-docs\"] --> Sdk\n Dogfood --> Sdk\n```\n\n- **Humans** consume `docify-web` + theme assets from the assembled `dist/web`.\n- **Agents** consume MD packs from the bundle and/or a published product knowledge SDK built on `docify-sdk`.\n- **`@x12i/docify`** is this platform’s own knowledge SDK (docs of docify).\n\n---\n\n## From: Packages — 3. Publish and install\n\nFrom the monorepo (uses root `.npmrc`):\n\n```bash\nbash scripts/publish-docify.sh\n```\n\nTypical product install:\n\n```bash\nnpm i @x12i/docify-core @x12i/docify-theme @x12i/docify-render \\\n @x12i/docify-export @x12i/docify-sdk @x12i/docify-web\nnpm i -D @x12i/docify # this platform’s docs knowledge SDK\nnpm i -D @x12i/memorix-docs # example product knowledge SDK\n```\n\nIn this monorepo, product builds usually **import from source** under `x12i-docify/packages/*/dist` rather than resolving published tarballs during local `npm run docs`.\n\n---\n\n## Also see\n\n- **Packages** (`01-packages`) — Core, theme, render, export, SDK, web, and screenshots — what each package owns.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
611
1697
|
"downloads/use-cases/orient-docify.md": "# Orient on x12i-docify\n\n> **Use case id:** `orient-docify`\n> **Goal:** Understand the dual-audience platform and where product libraries fit.\n> **Audiences:** developers, builders\n> **Tags:** platform, start-here\n\n## Reading path\n\n1. **Platform Overview** (developers) → chapters: `the-central-idea`, `1-what-x12i-docify-is`, `2-layers`, `4-where-to-go-next`\n\n## From: Platform Overview — The central idea\n\n**x12i-docify** is the reusable **product site + docs + knowledge packs** platform for x12i monorepos.\n\n> One content library (`BOOK.md` + use cases). Two consumption surfaces. Same design system everywhere — products change naming and content only.\n\n| Audience | Best form | What we ship |\n|---|---|---|\n| **Humans** | Web app | Product home, docs hub, roles, use cases, catalog, book landings, chapter reader, MD/PDF downloads — `@x12i/docify-web` |\n| **AI agents** | Markdown + packages | Per-book MD, use-case packs, chapter indexes, `agent-manifest.json`, `@x12i/docify-sdk` / product `@…-docs` |\n\nKnowledge SDKs are **devDependencies** — documentation for tools and agents, not a production runtime.\n\n---\n\n## From: Platform Overview — 1. What x12i-docify is\n\n### The problem it solves\n\nEvery product monorepo needs:\n\n- a branded docs **site** humans can browse,\n- **ebooks** with stable chapter structure,\n- **task-first use cases** that deep-link into chapters,\n- **agent-friendly** Markdown packs and a discoverable manifest,\n- one **visual system** so products do not invent competing UIs.\n\nDocify answers that with shared packages. Product folders supply content and brand strings only.\n\n### Who uses what\n\n| You are… | Primary surface | Install |\n|---|---|---|\n| Reader (human) | Product `dist/web` | Nothing — open the site |\n| Content author | `BOOK.md` + `site-pages` + `data/*.json` | Platform packages in the monorepo |\n| Integrator / platform engineer | `@x12i/docify-*` | Platform packages; optional product `@…-docs` as `devDependency` |\n| AI agent / tooling | MD downloads + knowledge SDK | `npm i -D @your-scope/<product>-docs` |\n\n---\n\n## From: Platform Overview — 2. Layers\n\n```mermaid\nflowchart TB\n Platform[x12i-docify platform packages]\n Product[\"<product>-docs content library\"]\n Web[dist/web for humans]\n SDK[\"@…-docs knowledge package\"]\n Product --> Platform\n Product --> Web\n Product --> SDK\n```\n\n| Layer | What it is |\n|---|---|\n| `x12i-docify` | Shared platform (theme, render, web, export, SDK, screenshots) |\n| `<product>-docs/` | Product content: books, site-pages, catalog, use cases |\n| `@x12i/<product>-docs` | Knowledge SDK + MD packs for agents (`npm i -D`) |\n\nMemorix is the large reference implementation: `memorix-docs/` → `@x12i/memorix-docs`. \n**This library** is the platform documenting itself (dogfood).\n\n---\n\n## From: Platform Overview — 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Package map | [Packages](../../01-packages/developers/BOOK.md) |\n| Wire a new library | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Human site behavior | [For Humans](../../03-for-humans/developers/BOOK.md) |\n| Agent / SDK path | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Theme contract | [Design System](../../05-design/developers/BOOK.md) |\n\n## Also see\n\n- **Platform Overview** (`00-platform-overview`) — What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
612
|
-
"downloads/use-cases/ship-agent-packs.md": "# Ship agent markdown and knowledge SDK\n\n> **Use case id:** `ship-agent-packs`\n> **Goal:** Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n> **Audiences:** developers\n> **Tags:** agents, sdk\n\n## Reading path\n\n1. **For Agents** (developers) → chapters: `1-best-form-for-agents`, `2-discovery`, `3-knowledge-sdk`, `4-install-contract`\n\n## From: For Agents — 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## From: For Agents — 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## From: For Agents — 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## From: For Agents — 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n\n## Also see\n\n- **For Agents** (`04-for-agents`) — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1698
|
+
"downloads/use-cases/ship-agent-packs.md": "# Ship agent markdown and knowledge SDK\n\n> **Use case id:** `ship-agent-packs`\n> **Goal:** Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n> **Audiences:** developers\n> **Tags:** agents, sdk\n\n## Reading path\n\n1. **For Agents** (developers) → chapters: `1-best-form-for-agents`, `2-discovery`, `3-knowledge-sdk`, `4-install-contract`\n\n## From: For Agents — 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## From: For Agents — 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## From: For Agents — 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## From: For Agents — 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n\nStart-here version with the full why/when: [Getting Started & Tutorials — Installation for agents](../../06-getting-started-and-tutorials/developers/BOOK.md).\n\n## Also see\n\n- **For Agents** (`04-for-agents`) — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
613
1699
|
"downloads/use-cases/ship-human-site.md": "# Ship the human web app\n\n> **Use case id:** `ship-human-site`\n> **Goal:** Build and serve dist/web with roles, use cases, catalog, and chapter reader.\n> **Audiences:** developers, builders\n> **Tags:** humans, web\n\n## Reading path\n\n1. **For Humans** (developers) → chapters: `1-best-form-for-humans`, `2-typical-flow`, `3-what-the-bundle-emits`\n\n## From: For Humans — 1. Best form for humans\n\nThe **web app** (`@x12i/docify-web`) is the human surface: case-file UI, role chooser, use-case routing, chapter reader, and download buttons.\n\nHumans should not be asked to scrape Markdown repos as their primary path. Deploy the static tree.\n\n---\n\n## From: For Humans — 2. Typical flow\n\n1. **Role** — pick developers / builders (or product-defined roles)\n2. **Use cases** — task-first entry; opens the right book + chapter\n3. **Catalog** — browse books by family\n4. **Reader** — chapter HTML in the shared book theme\n5. **Downloads** — MD (and PDF when built) for offline reading\n\nProduct home (`/`) and docs hub (`/docs`) are authored as site-pages with YAML front-matter.\n\n---\n\n## From: For Humans — 3. What the bundle emits\n\n| Path | Role |\n|---|---|\n| `index.html`, `docs.html`, … | Marketing / docs chrome from site-pages |\n| `books/<id>.html` | Book landings |\n| `read.html` + chapter HTML | Reader shell |\n| `catalog.json`, `use-cases.json`, `site.json` | Client data |\n| `downloads/` | MD / PDF / chapter indexes |\n| `agent-manifest.json` | Also useful for humans’ tooling links |\n\nAssemble with `buildContentBundle`, then overlay `docify-web/public` runtime assets (`app.js`, `read.html`, `agents.html`).\n\n---\n\n## Also see\n\n- **For Humans** (`03-for-humans`) — How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
614
1700
|
"downloads/use-cases/wire-product-library.md": "# Wire a product docs library\n\n> **Use case id:** `wire-product-library`\n> **Goal:** Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\n> **Audiences:** developers, builders\n> **Tags:** authoring, getting-started\n\n## Reading path\n\n1. **Authoring a Library** (developers) → chapters: `1-recipe`, `2-content-layout`, `3-data-contracts`, `4-build-pipeline`\n\n## From: Authoring a Library — 1. Recipe\n\n1. Depend on `@x12i/docify-{core,theme,render,export,sdk,web}` — do **not** fork theme or web app.\n2. Author books as `NN-slug/{audience}/BOOK.md`.\n3. Add product data:\n - `data/site.json` — `product`, `brand`, `brandAccent`, `siteUrl`, `knowledgePackage`\n - `data/catalog.json` — roles, families, books (kickers / colors / titles)\n - `data/use-cases.json` — task → book + chapter slugs\n4. Add `site-pages/*.md` with YAML front-matter (`product-home`, `docs-home`, …).\n5. Wire build scripts to import platform packages (see `memorix-docs/scripts/` or `x12i-docify/scripts/`).\n6. Publish `@your-scope/<product>-docs` as a **devDependency** knowledge SDK.\n7. Deploy `dist/web` for humans; ship MD + `agent-manifest.json` for agents.\n\n---\n\n## From: Authoring a Library — 2. Content layout\n\n```\n<product>-docs/\n data/{site,catalog,use-cases}.json\n site-pages/*.md\n NN-slug/\n developers/BOOK.md\n builders/BOOK.md # optional twin\n site-pages/landing.md\n diagrams/ … screenshots/\n packages/<product>-docs/ # published knowledge SDK\n scripts/build-bundle.mjs\n scripts/build-knowledge.mjs\n scripts/docs.mjs\n```\n\n---\n\n## From: Authoring a Library — 3. Data contracts\n\n| File | Owns |\n|---|---|\n| `site.json` | Brand chrome, accent CSS colors, nav, knowledge package name |\n| `catalog.json` | Roles (`developers` \\| `builders`), families, book metadata |\n| `use-cases.json` | Stable use-case ids + reading paths (bookId, audience, chapter slugs) |\n\nChapter slugs are produced by slugifying `##` headings in `BOOK.md`. Broken use-case paths **fail the bundle build**.\n\n---\n\n## From: Authoring a Library — 4. Build pipeline\n\nTypical scripts:\n\n| Script | Job |\n|---|---|\n| `build-bundle.mjs` | `buildContentBundle` → `dist/bundle` + assemble `dist/web` |\n| `build-knowledge.mjs` | Embed downloads + JSON into `packages/<sdk>/src/generated/bundle.ts` |\n| `docs.mjs` | Build if needed, `docify-web serve dist/web`, open browser |\n\nEnv: set `EBOOKS_PDF=0` or `DOCIFY_PDF=0` to skip PDF when `wkhtmltopdf` is unavailable.\n\n---\n\n## Also see\n\n- **Authoring a Library** (`02-authoring`) — Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
615
|
-
"
|
|
616
|
-
"
|
|
617
|
-
"site.json": "{\"product\":\"docify\",\"brand\":\"x12i · docify\",\"brandAccent\":\"docify\",\"siteUrl\":\"https://docs.docify.x12i.com\",\"knowledgePackage\":\"@x12i/docify\",\"footer\":\"x12i-docify\",\"accent\":\"oklch(55% 0.15 260)\",\"accentAlt\":\"oklch(60% 0.15 40)\",\"productUrl\":\"https://github.com/x12i/memorix-mono-repo/tree/main/x12i-docify\",\"nav\":[{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"}],\"footerLinks\":[{\"label\":\"Docs home\",\"href\":\"/docs\"},{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"},{\"label\":\"Agents/SDK\",\"href\":\"/agents\"},{\"label\":\"Platform README\",\"href\":\"https://github.com/x12i/memorix-mono-repo/tree/main/x12i-docify\"}]}",
|
|
618
|
-
"agent-manifest.json": "{\"version\":1,\"product\":\"docify\",\"site\":\"https://docs.docify.x12i.com\",\"knowledgePackage\":\"@x12i/docify\",\"roles\":[\"developers\",\"builders\"],\"books\":[{\"id\":\"00-platform-overview\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/00-platform-overview/developers.md\",\"builders\":\"downloads/books/00-platform-overview/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/00-platform-overview/developers.chapters.json\",\"builders\":\"downloads/books/00-platform-overview/builders.chapters.json\"}},{\"id\":\"01-packages\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/01-packages/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/01-packages/developers.chapters.json\"}},{\"id\":\"02-authoring\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/02-authoring/developers.md\",\"builders\":\"downloads/books/02-authoring/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/02-authoring/developers.chapters.json\",\"builders\":\"downloads/books/02-authoring/builders.chapters.json\"}},{\"id\":\"03-for-humans\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/03-for-humans/developers.md\",\"builders\":\"downloads/books/03-for-humans/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/03-for-humans/developers.chapters.json\",\"builders\":\"downloads/books/03-for-humans/builders.chapters.json\"}},{\"id\":\"04-for-agents\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/04-for-agents/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/04-for-agents/developers.chapters.json\"}},{\"id\":\"05-design\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/05-design/developers.md\",\"builders\":\"downloads/books/05-design/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/05-design/developers.chapters.json\",\"builders\":\"downloads/books/05-design/builders.chapters.json\"}}],\"useCases\":[{\"id\":\"orient-docify\",\"title\":\"Orient on x12i-docify\",\"md\":\"downloads/use-cases/orient-docify.md\",\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-central-idea\",\"1-what-x12i-docify-is\",\"2-layers\",\"4-where-to-go-next\"]}]},{\"id\":\"map-packages\",\"title\":\"Map the @x12i/docify-* packages\",\"md\":\"downloads/use-cases/map-packages.md\",\"path\":[{\"bookId\":\"01-packages\",\"audience\":\"developers\",\"chapters\":[\"1-package-table\",\"2-dependency-shape\",\"3-publish-and-install\"]}]},{\"id\":\"wire-product-library\",\"title\":\"Wire a product docs library\",\"md\":\"downloads/use-cases/wire-product-library.md\",\"path\":[{\"bookId\":\"02-authoring\",\"audience\":\"developers\",\"chapters\":[\"1-recipe\",\"2-content-layout\",\"3-data-contracts\",\"4-build-pipeline\"]}]},{\"id\":\"ship-human-site\",\"title\":\"Ship the human web app\",\"md\":\"downloads/use-cases/ship-human-site.md\",\"path\":[{\"bookId\":\"03-for-humans\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-humans\",\"2-typical-flow\",\"3-what-the-bundle-emits\"]}]},{\"id\":\"ship-agent-packs\",\"title\":\"Ship agent markdown and knowledge SDK\",\"md\":\"downloads/use-cases/ship-agent-packs.md\",\"path\":[{\"bookId\":\"04-for-agents\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-agents\",\"2-discovery\",\"3-knowledge-sdk\",\"4-install-contract\"]}]},{\"id\":\"keep-one-design\",\"title\":\"Keep one design system\",\"md\":\"downloads/use-cases/keep-one-design.md\",\"path\":[{\"bookId\":\"05-design\",\"audience\":\"builders\",\"chapters\":[\"1-principle\",\"2-identity\",\"3-surfaces\",\"4-do-not\"]}]}]}"
|
|
1701
|
+
"agent/INDEX.md": "# docify — knowledge index\n\nPackage: `@x12i/docify`\n\n## How to choose\n\n- **Concept** — what it is and why it exists\n- **Guide** — bounded task procedure\n- **Scenario** — state + evidence → which path\n- **Use case** — end-to-end outcome\n- **Tutorial** — learn by doing\n- **Decision** — options and recommended default\n- **Reference / API** — exact technical detail\n\n## Manifest and search\n\n- `agent-manifest.json`\n- `SEARCH.json`\n\n## Concepts\n\n- `explicit-authoring` — **Explicit authoring** — Docify only builds knowledge that authors declare — it never discovers product truth from source. — [concepts/explicit-authoring.md](concepts/explicit-authoring.md)\n- `open-markdown` — **Open Markdown baseline** — Every knowledge item ships as readable Markdown plus indexes — the SDK is optional. — [concepts/open-markdown.md](concepts/open-markdown.md)\n- `guide-vs-scenario` — **Guides vs scenarios vs journeys** — Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome. — [concepts/guide-vs-scenario.md](concepts/guide-vs-scenario.md)\n\n## Guides\n\n- `scaffold-concept` — **Scaffold a concept page** — Create a validated concept with problem, why, and mental model. — [guides/scaffold-concept.md](guides/scaffold-concept.md)\n\n## Scenarios\n\n- `choose-content-type` — **Choose the right Docify content type** — Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal. — [scenarios/choose-content-type.md](scenarios/choose-content-type.md)\n\n## Diagrams\n\n- `docify-dual-audience` — **One library, two consumption surfaces** — Explicitly authored content becomes a human website and an agent knowledge package. — [diagrams/docify-dual-audience.md](diagrams/docify-dual-audience.md)\n\n## Tutorials\n\n_None authored yet._\n",
|
|
1702
|
+
"INDEX.md": "# docify — knowledge index\n\nPackage: `@x12i/docify`\n\n## How to choose\n\n- **Concept** — what it is and why it exists\n- **Guide** — bounded task procedure\n- **Scenario** — state + evidence → which path\n- **Use case** — end-to-end outcome\n- **Tutorial** — learn by doing\n- **Decision** — options and recommended default\n- **Reference / API** — exact technical detail\n\n## Manifest and search\n\n- `agent-manifest.json`\n- `SEARCH.json`\n\n## Concepts\n\n- `explicit-authoring` — **Explicit authoring** — Docify only builds knowledge that authors declare — it never discovers product truth from source. — [concepts/explicit-authoring.md](concepts/explicit-authoring.md)\n- `open-markdown` — **Open Markdown baseline** — Every knowledge item ships as readable Markdown plus indexes — the SDK is optional. — [concepts/open-markdown.md](concepts/open-markdown.md)\n- `guide-vs-scenario` — **Guides vs scenarios vs journeys** — Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome. — [concepts/guide-vs-scenario.md](concepts/guide-vs-scenario.md)\n\n## Guides\n\n- `scaffold-concept` — **Scaffold a concept page** — Create a validated concept with problem, why, and mental model. — [guides/scaffold-concept.md](guides/scaffold-concept.md)\n\n## Scenarios\n\n- `choose-content-type` — **Choose the right Docify content type** — Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal. — [scenarios/choose-content-type.md](scenarios/choose-content-type.md)\n\n## Diagrams\n\n- `docify-dual-audience` — **One library, two consumption surfaces** — Explicitly authored content becomes a human website and an agent knowledge package. — [diagrams/docify-dual-audience.md](diagrams/docify-dual-audience.md)\n\n## Tutorials\n\n_None authored yet._\n",
|
|
1703
|
+
"agent/SEARCH.json": "{\n \"version\": 1,\n \"product\": \"docify\",\n \"generatedAt\": \"2026-07-26T10:51:47.660Z\",\n \"records\": [\n {\n \"id\": \"explicit-authoring\",\n \"type\": \"concept\",\n \"title\": \"Explicit authoring\",\n \"summary\": \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"authoring\",\n \"boundary\"\n ],\n \"goals\": [],\n \"path\": \"concepts/explicit-authoring.md\",\n \"webPath\": \"/concepts/explicit-authoring\",\n \"prerequisites\": [],\n \"related\": [\n \"open-markdown\",\n \"knowledge-relationships\"\n ],\n \"packIds\": [\n \"concept/explicit-authoring\"\n ]\n },\n {\n \"id\": \"open-markdown\",\n \"type\": \"concept\",\n \"title\": \"Open Markdown baseline\",\n \"summary\": \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\"\n ],\n \"tags\": [\n \"agents\",\n \"packaging\"\n ],\n \"goals\": [],\n \"path\": \"concepts/open-markdown.md\",\n \"webPath\": \"/concepts/open-markdown\",\n \"prerequisites\": [],\n \"related\": [\n \"explicit-authoring\"\n ],\n \"packIds\": [\n \"concept/open-markdown\"\n ]\n },\n {\n \"id\": \"guide-vs-scenario\",\n \"type\": \"concept\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"summary\": \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"authoring\"\n ],\n \"goals\": [],\n \"path\": \"concepts/guide-vs-scenario.md\",\n \"webPath\": \"/concepts/guide-vs-scenario\",\n \"prerequisites\": [],\n \"related\": [\n \"explicit-authoring\"\n ],\n \"packIds\": [\n \"concept/guide-vs-scenario\"\n ]\n },\n {\n \"id\": \"scaffold-concept\",\n \"type\": \"guide\",\n \"title\": \"Scaffold a concept page\",\n \"summary\": \"Create a validated concept with problem, why, and mental model.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"authoring\"\n ],\n \"goals\": [],\n \"path\": \"guides/scaffold-concept.md\",\n \"webPath\": \"/guides/scaffold-concept\",\n \"prerequisites\": [],\n \"related\": [\n \"explicit-authoring\"\n ],\n \"packIds\": [\n \"guide/scaffold-concept\"\n ]\n },\n {\n \"id\": \"choose-content-type\",\n \"type\": \"scenario\",\n \"title\": \"Choose the right Docify content type\",\n \"summary\": \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [],\n \"goals\": [\n \"Which Docify content type fits this goal?\"\n ],\n \"path\": \"scenarios/choose-content-type.md\",\n \"webPath\": \"/scenarios/choose-content-type\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": [\n \"scenario/choose-content-type\"\n ]\n },\n {\n \"id\": \"docify\",\n \"type\": \"glossary\",\n \"title\": \"Docify\",\n \"summary\": \"x12i framework that turns explicitly authored product knowledge into a website and agent package.\",\n \"aliases\": [\n \"x12i-docify\"\n ],\n \"audiences\": [],\n \"tags\": [],\n \"goals\": [],\n \"path\": \"glossary/docify.md\",\n \"prerequisites\": [],\n \"related\": [\n \"explicit-authoring\"\n ],\n \"packIds\": []\n },\n {\n \"id\": \"search-json\",\n \"type\": \"glossary\",\n \"title\": \"SEARCH.json\",\n \"summary\": \"Deterministic local search index over all addressable knowledge items.\",\n \"aliases\": [\n \"search index\"\n ],\n \"audiences\": [],\n \"tags\": [],\n \"goals\": [],\n \"path\": \"glossary/search-json.md\",\n \"prerequisites\": [],\n \"related\": [\n \"open-markdown\"\n ],\n \"packIds\": []\n },\n {\n \"id\": \"docify-dual-audience\",\n \"type\": \"diagram\",\n \"title\": \"One library, two consumption surfaces\",\n \"summary\": \"Explicitly authored content becomes a human website and an agent knowledge package.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"platform\"\n ],\n \"goals\": [],\n \"path\": \"diagrams/docify-dual-audience.md\",\n \"webPath\": \"/diagrams/docify-dual-audience\",\n \"prerequisites\": [],\n \"related\": [\n \"explicit-authoring\",\n \"open-markdown\"\n ],\n \"packIds\": []\n },\n {\n \"id\": \"orient-docify\",\n \"type\": \"use-case\",\n \"title\": \"Orient on x12i-docify\",\n \"summary\": \"Understand the dual-audience platform and where product libraries fit.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"platform\",\n \"start-here\"\n ],\n \"goals\": [\n \"Understand the dual-audience platform and where product libraries fit.\"\n ],\n \"path\": \"use-cases/orient-docify.md\",\n \"webPath\": \"/use-cases#orient-docify\",\n \"prerequisites\": [],\n \"related\": [\n \"00-platform-overview\"\n ],\n \"packIds\": [\n \"use-case/orient-docify\"\n ]\n },\n {\n \"id\": \"map-packages\",\n \"type\": \"use-case\",\n \"title\": \"Map the @x12i/docify-* packages\",\n \"summary\": \"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\"\n ],\n \"tags\": [\n \"packages\",\n \"npm\"\n ],\n \"goals\": [\n \"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\"\n ],\n \"path\": \"use-cases/map-packages.md\",\n \"webPath\": \"/use-cases#map-packages\",\n \"prerequisites\": [],\n \"related\": [\n \"01-packages\"\n ],\n \"packIds\": [\n \"use-case/map-packages\"\n ]\n },\n {\n \"id\": \"wire-product-library\",\n \"type\": \"use-case\",\n \"title\": \"Wire a product docs library\",\n \"summary\": \"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"authoring\",\n \"getting-started\"\n ],\n \"goals\": [\n \"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\"\n ],\n \"path\": \"use-cases/wire-product-library.md\",\n \"webPath\": \"/use-cases#wire-product-library\",\n \"prerequisites\": [],\n \"related\": [\n \"02-authoring\",\n \"05-design\"\n ],\n \"packIds\": [\n \"use-case/wire-product-library\"\n ]\n },\n {\n \"id\": \"ship-human-site\",\n \"type\": \"use-case\",\n \"title\": \"Ship the human web app\",\n \"summary\": \"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"humans\",\n \"web\"\n ],\n \"goals\": [\n \"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\"\n ],\n \"path\": \"use-cases/ship-human-site.md\",\n \"webPath\": \"/use-cases#ship-human-site\",\n \"prerequisites\": [],\n \"related\": [\n \"03-for-humans\"\n ],\n \"packIds\": [\n \"use-case/ship-human-site\"\n ]\n },\n {\n \"id\": \"ship-agent-packs\",\n \"type\": \"use-case\",\n \"title\": \"Ship agent markdown and knowledge SDK\",\n \"summary\": \"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\"\n ],\n \"tags\": [\n \"agents\",\n \"sdk\"\n ],\n \"goals\": [\n \"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\"\n ],\n \"path\": \"use-cases/ship-agent-packs.md\",\n \"webPath\": \"/use-cases#ship-agent-packs\",\n \"prerequisites\": [],\n \"related\": [\n \"04-for-agents\"\n ],\n \"packIds\": [\n \"use-case/ship-agent-packs\"\n ]\n },\n {\n \"id\": \"keep-one-design\",\n \"type\": \"use-case\",\n \"title\": \"Keep one design system\",\n \"summary\": \"Change product naming and content only — never fork theme or invent a competing palette.\",\n \"aliases\": [],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"design\",\n \"theme\"\n ],\n \"goals\": [\n \"Change product naming and content only — never fork theme or invent a competing palette.\"\n ],\n \"path\": \"use-cases/keep-one-design.md\",\n \"webPath\": \"/use-cases#keep-one-design\",\n \"prerequisites\": [],\n \"related\": [\n \"05-design\"\n ],\n \"packIds\": [\n \"use-case/keep-one-design\"\n ]\n },\n {\n \"id\": \"00-platform-overview\",\n \"type\": \"book\",\n \"title\": \"Platform Overview\",\n \"summary\": \"What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\",\n \"aliases\": [\n \"CASE FILE · DOC-00\"\n ],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"platform\",\n \"start-here\",\n \"overview\"\n ],\n \"goals\": [],\n \"path\": \"books/00-platform-overview/\",\n \"webPath\": \"/books/00-platform-overview\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"01-packages\",\n \"type\": \"book\",\n \"title\": \"Packages\",\n \"summary\": \"Core, theme, render, export, SDK, web, and screenshots — what each package owns.\",\n \"aliases\": [\n \"CASE FILE · DOC-01\"\n ],\n \"audiences\": [\n \"developers\"\n ],\n \"tags\": [\n \"packages\",\n \"npm\",\n \"platform\"\n ],\n \"goals\": [],\n \"path\": \"books/01-packages/\",\n \"webPath\": \"/books/01-packages\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"02-authoring\",\n \"type\": \"book\",\n \"title\": \"Authoring a Library\",\n \"summary\": \"Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\",\n \"aliases\": [\n \"CASE FILE · DOC-02\"\n ],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"authoring\",\n \"content\",\n \"getting-started\"\n ],\n \"goals\": [],\n \"path\": \"books/02-authoring/\",\n \"webPath\": \"/books/02-authoring\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"03-for-humans\",\n \"type\": \"book\",\n \"title\": \"For Humans\",\n \"summary\": \"How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\",\n \"aliases\": [\n \"CASE FILE · DOC-03\"\n ],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"humans\",\n \"web\",\n \"reader\"\n ],\n \"goals\": [],\n \"path\": \"books/03-for-humans/\",\n \"webPath\": \"/books/03-for-humans\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"04-for-agents\",\n \"type\": \"book\",\n \"title\": \"For Agents\",\n \"summary\": \"MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\",\n \"aliases\": [\n \"CASE FILE · DOC-04\"\n ],\n \"audiences\": [\n \"developers\"\n ],\n \"tags\": [\n \"agents\",\n \"sdk\",\n \"markdown\"\n ],\n \"goals\": [],\n \"path\": \"books/04-for-agents/\",\n \"webPath\": \"/books/04-for-agents\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"05-design\",\n \"type\": \"book\",\n \"title\": \"Design System\",\n \"summary\": \"Shared theme tokens and surfaces — products change naming and content only.\",\n \"aliases\": [\n \"CASE FILE · DOC-05\"\n ],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"design\",\n \"theme\",\n \"brand\"\n ],\n \"goals\": [],\n \"path\": \"books/05-design/\",\n \"webPath\": \"/books/05-design\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n },\n {\n \"id\": \"06-getting-started-and-tutorials\",\n \"type\": \"book\",\n \"title\": \"Getting Started & Tutorials\",\n \"summary\": \"Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\",\n \"aliases\": [\n \"CASE FILE · DOC-06\"\n ],\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"tags\": [\n \"getting-started\",\n \"tutorials\",\n \"install\",\n \"start-here\"\n ],\n \"goals\": [],\n \"path\": \"books/06-getting-started-and-tutorials/\",\n \"webPath\": \"/books/06-getting-started-and-tutorials\",\n \"prerequisites\": [],\n \"related\": [],\n \"packIds\": []\n }\n ]\n}",
|
|
1704
|
+
"SEARCH.json": "{\"version\":1,\"product\":\"docify\",\"generatedAt\":\"2026-07-26T10:51:47.660Z\",\"records\":[{\"id\":\"explicit-authoring\",\"type\":\"concept\",\"title\":\"Explicit authoring\",\"summary\":\"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\",\"boundary\"],\"goals\":[],\"path\":\"concepts/explicit-authoring.md\",\"webPath\":\"/concepts/explicit-authoring\",\"prerequisites\":[],\"related\":[\"open-markdown\",\"knowledge-relationships\"],\"packIds\":[\"concept/explicit-authoring\"]},{\"id\":\"open-markdown\",\"type\":\"concept\",\"title\":\"Open Markdown baseline\",\"summary\":\"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\"aliases\":[],\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"packaging\"],\"goals\":[],\"path\":\"concepts/open-markdown.md\",\"webPath\":\"/concepts/open-markdown\",\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"packIds\":[\"concept/open-markdown\"]},{\"id\":\"guide-vs-scenario\",\"type\":\"concept\",\"title\":\"Guides vs scenarios vs journeys\",\"summary\":\"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\"],\"goals\":[],\"path\":\"concepts/guide-vs-scenario.md\",\"webPath\":\"/concepts/guide-vs-scenario\",\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"packIds\":[\"concept/guide-vs-scenario\"]},{\"id\":\"scaffold-concept\",\"type\":\"guide\",\"title\":\"Scaffold a concept page\",\"summary\":\"Create a validated concept with problem, why, and mental model.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\"],\"goals\":[],\"path\":\"guides/scaffold-concept.md\",\"webPath\":\"/guides/scaffold-concept\",\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"packIds\":[\"guide/scaffold-concept\"]},{\"id\":\"choose-content-type\",\"type\":\"scenario\",\"title\":\"Choose the right Docify content type\",\"summary\":\"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[],\"goals\":[\"Which Docify content type fits this goal?\"],\"path\":\"scenarios/choose-content-type.md\",\"webPath\":\"/scenarios/choose-content-type\",\"prerequisites\":[],\"related\":[],\"packIds\":[\"scenario/choose-content-type\"]},{\"id\":\"docify\",\"type\":\"glossary\",\"title\":\"Docify\",\"summary\":\"x12i framework that turns explicitly authored product knowledge into a website and agent package.\",\"aliases\":[\"x12i-docify\"],\"audiences\":[],\"tags\":[],\"goals\":[],\"path\":\"glossary/docify.md\",\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"packIds\":[]},{\"id\":\"search-json\",\"type\":\"glossary\",\"title\":\"SEARCH.json\",\"summary\":\"Deterministic local search index over all addressable knowledge items.\",\"aliases\":[\"search index\"],\"audiences\":[],\"tags\":[],\"goals\":[],\"path\":\"glossary/search-json.md\",\"prerequisites\":[],\"related\":[\"open-markdown\"],\"packIds\":[]},{\"id\":\"docify-dual-audience\",\"type\":\"diagram\",\"title\":\"One library, two consumption surfaces\",\"summary\":\"Explicitly authored content becomes a human website and an agent knowledge package.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\"],\"goals\":[],\"path\":\"diagrams/docify-dual-audience.md\",\"webPath\":\"/diagrams/docify-dual-audience\",\"prerequisites\":[],\"related\":[\"explicit-authoring\",\"open-markdown\"],\"packIds\":[]},{\"id\":\"orient-docify\",\"type\":\"use-case\",\"title\":\"Orient on x12i-docify\",\"summary\":\"Understand the dual-audience platform and where product libraries fit.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\",\"start-here\"],\"goals\":[\"Understand the dual-audience platform and where product libraries fit.\"],\"path\":\"use-cases/orient-docify.md\",\"webPath\":\"/use-cases#orient-docify\",\"prerequisites\":[],\"related\":[\"00-platform-overview\"],\"packIds\":[\"use-case/orient-docify\"]},{\"id\":\"map-packages\",\"type\":\"use-case\",\"title\":\"Map the @x12i/docify-* packages\",\"summary\":\"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\",\"aliases\":[],\"audiences\":[\"developers\"],\"tags\":[\"packages\",\"npm\"],\"goals\":[\"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\"],\"path\":\"use-cases/map-packages.md\",\"webPath\":\"/use-cases#map-packages\",\"prerequisites\":[],\"related\":[\"01-packages\"],\"packIds\":[\"use-case/map-packages\"]},{\"id\":\"wire-product-library\",\"type\":\"use-case\",\"title\":\"Wire a product docs library\",\"summary\":\"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\",\"getting-started\"],\"goals\":[\"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\"],\"path\":\"use-cases/wire-product-library.md\",\"webPath\":\"/use-cases#wire-product-library\",\"prerequisites\":[],\"related\":[\"02-authoring\",\"05-design\"],\"packIds\":[\"use-case/wire-product-library\"]},{\"id\":\"ship-human-site\",\"type\":\"use-case\",\"title\":\"Ship the human web app\",\"summary\":\"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"humans\",\"web\"],\"goals\":[\"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\"],\"path\":\"use-cases/ship-human-site.md\",\"webPath\":\"/use-cases#ship-human-site\",\"prerequisites\":[],\"related\":[\"03-for-humans\"],\"packIds\":[\"use-case/ship-human-site\"]},{\"id\":\"ship-agent-packs\",\"type\":\"use-case\",\"title\":\"Ship agent markdown and knowledge SDK\",\"summary\":\"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\",\"aliases\":[],\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"sdk\"],\"goals\":[\"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\"],\"path\":\"use-cases/ship-agent-packs.md\",\"webPath\":\"/use-cases#ship-agent-packs\",\"prerequisites\":[],\"related\":[\"04-for-agents\"],\"packIds\":[\"use-case/ship-agent-packs\"]},{\"id\":\"keep-one-design\",\"type\":\"use-case\",\"title\":\"Keep one design system\",\"summary\":\"Change product naming and content only — never fork theme or invent a competing palette.\",\"aliases\":[],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"design\",\"theme\"],\"goals\":[\"Change product naming and content only — never fork theme or invent a competing palette.\"],\"path\":\"use-cases/keep-one-design.md\",\"webPath\":\"/use-cases#keep-one-design\",\"prerequisites\":[],\"related\":[\"05-design\"],\"packIds\":[\"use-case/keep-one-design\"]},{\"id\":\"00-platform-overview\",\"type\":\"book\",\"title\":\"Platform Overview\",\"summary\":\"What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\",\"aliases\":[\"CASE FILE · DOC-00\"],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\",\"start-here\",\"overview\"],\"goals\":[],\"path\":\"books/00-platform-overview/\",\"webPath\":\"/books/00-platform-overview\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"01-packages\",\"type\":\"book\",\"title\":\"Packages\",\"summary\":\"Core, theme, render, export, SDK, web, and screenshots — what each package owns.\",\"aliases\":[\"CASE FILE · DOC-01\"],\"audiences\":[\"developers\"],\"tags\":[\"packages\",\"npm\",\"platform\"],\"goals\":[],\"path\":\"books/01-packages/\",\"webPath\":\"/books/01-packages\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"02-authoring\",\"type\":\"book\",\"title\":\"Authoring a Library\",\"summary\":\"Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\",\"aliases\":[\"CASE FILE · DOC-02\"],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\",\"content\",\"getting-started\"],\"goals\":[],\"path\":\"books/02-authoring/\",\"webPath\":\"/books/02-authoring\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"03-for-humans\",\"type\":\"book\",\"title\":\"For Humans\",\"summary\":\"How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\",\"aliases\":[\"CASE FILE · DOC-03\"],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"humans\",\"web\",\"reader\"],\"goals\":[],\"path\":\"books/03-for-humans/\",\"webPath\":\"/books/03-for-humans\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"04-for-agents\",\"type\":\"book\",\"title\":\"For Agents\",\"summary\":\"MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\",\"aliases\":[\"CASE FILE · DOC-04\"],\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"sdk\",\"markdown\"],\"goals\":[],\"path\":\"books/04-for-agents/\",\"webPath\":\"/books/04-for-agents\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"05-design\",\"type\":\"book\",\"title\":\"Design System\",\"summary\":\"Shared theme tokens and surfaces — products change naming and content only.\",\"aliases\":[\"CASE FILE · DOC-05\"],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"design\",\"theme\",\"brand\"],\"goals\":[],\"path\":\"books/05-design/\",\"webPath\":\"/books/05-design\",\"prerequisites\":[],\"related\":[],\"packIds\":[]},{\"id\":\"06-getting-started-and-tutorials\",\"type\":\"book\",\"title\":\"Getting Started & Tutorials\",\"summary\":\"Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\",\"aliases\":[\"CASE FILE · DOC-06\"],\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"getting-started\",\"tutorials\",\"install\",\"start-here\"],\"goals\":[],\"path\":\"books/06-getting-started-and-tutorials/\",\"webPath\":\"/books/06-getting-started-and-tutorials\",\"prerequisites\":[],\"related\":[],\"packIds\":[]}]}",
|
|
1705
|
+
"agent/agent-manifest.json": "{\n \"version\": 1,\n \"product\": \"docify\",\n \"site\": \"https://docs.docify.x12i.com\",\n \"knowledgePackage\": \"@x12i/docify\",\n \"roles\": [\n \"developers\",\n \"builders\"\n ],\n \"books\": [\n {\n \"id\": \"00-platform-overview\",\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/00-platform-overview/developers.md\",\n \"builders\": \"downloads/books/00-platform-overview/builders.md\"\n },\n \"pdf\": {\n \"developers\": null,\n \"builders\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/00-platform-overview/developers.chapters.json\",\n \"builders\": \"downloads/books/00-platform-overview/builders.chapters.json\"\n }\n },\n {\n \"id\": \"01-packages\",\n \"audiences\": [\n \"developers\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/01-packages/developers.md\"\n },\n \"pdf\": {\n \"developers\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/01-packages/developers.chapters.json\"\n }\n },\n {\n \"id\": \"02-authoring\",\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/02-authoring/developers.md\",\n \"builders\": \"downloads/books/02-authoring/builders.md\"\n },\n \"pdf\": {\n \"developers\": null,\n \"builders\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/02-authoring/developers.chapters.json\",\n \"builders\": \"downloads/books/02-authoring/builders.chapters.json\"\n }\n },\n {\n \"id\": \"03-for-humans\",\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/03-for-humans/developers.md\",\n \"builders\": \"downloads/books/03-for-humans/builders.md\"\n },\n \"pdf\": {\n \"developers\": null,\n \"builders\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/03-for-humans/developers.chapters.json\",\n \"builders\": \"downloads/books/03-for-humans/builders.chapters.json\"\n }\n },\n {\n \"id\": \"04-for-agents\",\n \"audiences\": [\n \"developers\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/04-for-agents/developers.md\"\n },\n \"pdf\": {\n \"developers\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/04-for-agents/developers.chapters.json\"\n }\n },\n {\n \"id\": \"05-design\",\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/05-design/developers.md\",\n \"builders\": \"downloads/books/05-design/builders.md\"\n },\n \"pdf\": {\n \"developers\": null,\n \"builders\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/05-design/developers.chapters.json\",\n \"builders\": \"downloads/books/05-design/builders.chapters.json\"\n }\n },\n {\n \"id\": \"06-getting-started-and-tutorials\",\n \"audiences\": [\n \"developers\",\n \"builders\"\n ],\n \"md\": {\n \"developers\": \"downloads/books/06-getting-started-and-tutorials/developers.md\",\n \"builders\": \"downloads/books/06-getting-started-and-tutorials/builders.md\"\n },\n \"pdf\": {\n \"developers\": null,\n \"builders\": null\n },\n \"chapters\": {\n \"developers\": \"downloads/books/06-getting-started-and-tutorials/developers.chapters.json\",\n \"builders\": \"downloads/books/06-getting-started-and-tutorials/builders.chapters.json\"\n }\n }\n ],\n \"useCases\": [\n {\n \"id\": \"orient-docify\",\n \"title\": \"Orient on x12i-docify\",\n \"md\": \"downloads/use-cases/orient-docify.md\",\n \"path\": [\n {\n \"bookId\": \"00-platform-overview\",\n \"audience\": \"developers\",\n \"chapters\": [\n \"the-central-idea\",\n \"1-what-x12i-docify-is\",\n \"2-layers\",\n \"4-where-to-go-next\"\n ]\n }\n ]\n },\n {\n \"id\": \"map-packages\",\n \"title\": \"Map the @x12i/docify-* packages\",\n \"md\": \"downloads/use-cases/map-packages.md\",\n \"path\": [\n {\n \"bookId\": \"01-packages\",\n \"audience\": \"developers\",\n \"chapters\": [\n \"1-package-table\",\n \"2-dependency-shape\",\n \"3-publish-and-install\"\n ]\n }\n ]\n },\n {\n \"id\": \"wire-product-library\",\n \"title\": \"Wire a product docs library\",\n \"md\": \"downloads/use-cases/wire-product-library.md\",\n \"path\": [\n {\n \"bookId\": \"02-authoring\",\n \"audience\": \"developers\",\n \"chapters\": [\n \"1-recipe\",\n \"2-content-layout\",\n \"3-data-contracts\",\n \"4-build-pipeline\"\n ]\n }\n ]\n },\n {\n \"id\": \"ship-human-site\",\n \"title\": \"Ship the human web app\",\n \"md\": \"downloads/use-cases/ship-human-site.md\",\n \"path\": [\n {\n \"bookId\": \"03-for-humans\",\n \"audience\": \"developers\",\n \"chapters\": [\n \"1-best-form-for-humans\",\n \"2-typical-flow\",\n \"3-what-the-bundle-emits\"\n ]\n }\n ]\n },\n {\n \"id\": \"ship-agent-packs\",\n \"title\": \"Ship agent markdown and knowledge SDK\",\n \"md\": \"downloads/use-cases/ship-agent-packs.md\",\n \"path\": [\n {\n \"bookId\": \"04-for-agents\",\n \"audience\": \"developers\",\n \"chapters\": [\n \"1-best-form-for-agents\",\n \"2-discovery\",\n \"3-knowledge-sdk\",\n \"4-install-contract\"\n ]\n }\n ]\n },\n {\n \"id\": \"keep-one-design\",\n \"title\": \"Keep one design system\",\n \"md\": \"downloads/use-cases/keep-one-design.md\",\n \"path\": [\n {\n \"bookId\": \"05-design\",\n \"audience\": \"builders\",\n \"chapters\": [\n \"1-principle\",\n \"2-identity\",\n \"3-surfaces\",\n \"4-do-not\"\n ]\n }\n ]\n }\n ],\n \"indexes\": {\n \"indexMd\": \"INDEX.md\",\n \"searchJson\": \"SEARCH.json\"\n },\n \"concepts\": [\n {\n \"id\": \"explicit-authoring\",\n \"title\": \"Explicit authoring\",\n \"md\": \"concepts/explicit-authoring.md\"\n },\n {\n \"id\": \"open-markdown\",\n \"title\": \"Open Markdown baseline\",\n \"md\": \"concepts/open-markdown.md\"\n },\n {\n \"id\": \"guide-vs-scenario\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"md\": \"concepts/guide-vs-scenario.md\"\n }\n ],\n \"guides\": [\n {\n \"id\": \"scaffold-concept\",\n \"title\": \"Scaffold a concept page\",\n \"md\": \"guides/scaffold-concept.md\"\n }\n ],\n \"scenarios\": [\n {\n \"id\": \"choose-content-type\",\n \"title\": \"Choose the right Docify content type\",\n \"md\": \"scenarios/choose-content-type.md\"\n }\n ],\n \"decisions\": [],\n \"glossary\": [\n {\n \"id\": \"docify\",\n \"term\": \"Docify\",\n \"md\": \"glossary/docify.md\"\n },\n {\n \"id\": \"search-json\",\n \"term\": \"SEARCH.json\",\n \"md\": \"glossary/search-json.md\"\n }\n ],\n \"visuals\": [],\n \"diagrams\": [\n {\n \"id\": \"docify-dual-audience\",\n \"title\": \"One library, two consumption surfaces\",\n \"md\": \"diagrams/docify-dual-audience.md\",\n \"source\": \"diagrams/sources/docify-dual-audience.mmd\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"explicit-to-open-md\",\n \"type\": \"prerequisiteOf\",\n \"from\": \"explicit-authoring\",\n \"to\": \"open-markdown\"\n },\n {\n \"id\": \"types-related\",\n \"type\": \"relatedTo\",\n \"from\": \"guide-vs-scenario\",\n \"to\": \"explicit-authoring\"\n }\n ],\n \"tutorials\": [],\n \"examples\": [],\n \"sampleData\": [],\n \"uiClients\": [],\n \"apis\": [],\n \"packs\": [\n {\n \"id\": \"concept/explicit-authoring\",\n \"type\": \"concept\",\n \"path\": \"packs/concept/explicit-authoring\"\n },\n {\n \"id\": \"concept/open-markdown\",\n \"type\": \"concept\",\n \"path\": \"packs/concept/open-markdown\"\n },\n {\n \"id\": \"concept/guide-vs-scenario\",\n \"type\": \"concept\",\n \"path\": \"packs/concept/guide-vs-scenario\"\n },\n {\n \"id\": \"guide/scaffold-concept\",\n \"type\": \"guide\",\n \"path\": \"packs/guide/scaffold-concept\"\n },\n {\n \"id\": \"scenario/choose-content-type\",\n \"type\": \"scenario\",\n \"path\": \"packs/scenario/choose-content-type\"\n }\n ]\n}",
|
|
1706
|
+
"agent-manifest.json": "{\"version\":1,\"product\":\"docify\",\"site\":\"https://docs.docify.x12i.com\",\"knowledgePackage\":\"@x12i/docify\",\"roles\":[\"developers\",\"builders\"],\"books\":[{\"id\":\"00-platform-overview\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/00-platform-overview/developers.md\",\"builders\":\"downloads/books/00-platform-overview/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/00-platform-overview/developers.chapters.json\",\"builders\":\"downloads/books/00-platform-overview/builders.chapters.json\"}},{\"id\":\"01-packages\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/01-packages/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/01-packages/developers.chapters.json\"}},{\"id\":\"02-authoring\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/02-authoring/developers.md\",\"builders\":\"downloads/books/02-authoring/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/02-authoring/developers.chapters.json\",\"builders\":\"downloads/books/02-authoring/builders.chapters.json\"}},{\"id\":\"03-for-humans\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/03-for-humans/developers.md\",\"builders\":\"downloads/books/03-for-humans/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/03-for-humans/developers.chapters.json\",\"builders\":\"downloads/books/03-for-humans/builders.chapters.json\"}},{\"id\":\"04-for-agents\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/04-for-agents/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/04-for-agents/developers.chapters.json\"}},{\"id\":\"05-design\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/05-design/developers.md\",\"builders\":\"downloads/books/05-design/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/05-design/developers.chapters.json\",\"builders\":\"downloads/books/05-design/builders.chapters.json\"}},{\"id\":\"06-getting-started-and-tutorials\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/06-getting-started-and-tutorials/developers.md\",\"builders\":\"downloads/books/06-getting-started-and-tutorials/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/06-getting-started-and-tutorials/developers.chapters.json\",\"builders\":\"downloads/books/06-getting-started-and-tutorials/builders.chapters.json\"}}],\"useCases\":[{\"id\":\"orient-docify\",\"title\":\"Orient on x12i-docify\",\"md\":\"downloads/use-cases/orient-docify.md\",\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-central-idea\",\"1-what-x12i-docify-is\",\"2-layers\",\"4-where-to-go-next\"]}]},{\"id\":\"map-packages\",\"title\":\"Map the @x12i/docify-* packages\",\"md\":\"downloads/use-cases/map-packages.md\",\"path\":[{\"bookId\":\"01-packages\",\"audience\":\"developers\",\"chapters\":[\"1-package-table\",\"2-dependency-shape\",\"3-publish-and-install\"]}]},{\"id\":\"wire-product-library\",\"title\":\"Wire a product docs library\",\"md\":\"downloads/use-cases/wire-product-library.md\",\"path\":[{\"bookId\":\"02-authoring\",\"audience\":\"developers\",\"chapters\":[\"1-recipe\",\"2-content-layout\",\"3-data-contracts\",\"4-build-pipeline\"]}]},{\"id\":\"ship-human-site\",\"title\":\"Ship the human web app\",\"md\":\"downloads/use-cases/ship-human-site.md\",\"path\":[{\"bookId\":\"03-for-humans\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-humans\",\"2-typical-flow\",\"3-what-the-bundle-emits\"]}]},{\"id\":\"ship-agent-packs\",\"title\":\"Ship agent markdown and knowledge SDK\",\"md\":\"downloads/use-cases/ship-agent-packs.md\",\"path\":[{\"bookId\":\"04-for-agents\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-agents\",\"2-discovery\",\"3-knowledge-sdk\",\"4-install-contract\"]}]},{\"id\":\"keep-one-design\",\"title\":\"Keep one design system\",\"md\":\"downloads/use-cases/keep-one-design.md\",\"path\":[{\"bookId\":\"05-design\",\"audience\":\"builders\",\"chapters\":[\"1-principle\",\"2-identity\",\"3-surfaces\",\"4-do-not\"]}]}],\"indexes\":{\"indexMd\":\"INDEX.md\",\"searchJson\":\"SEARCH.json\"},\"concepts\":[{\"id\":\"explicit-authoring\",\"title\":\"Explicit authoring\",\"md\":\"concepts/explicit-authoring.md\"},{\"id\":\"open-markdown\",\"title\":\"Open Markdown baseline\",\"md\":\"concepts/open-markdown.md\"},{\"id\":\"guide-vs-scenario\",\"title\":\"Guides vs scenarios vs journeys\",\"md\":\"concepts/guide-vs-scenario.md\"}],\"guides\":[{\"id\":\"scaffold-concept\",\"title\":\"Scaffold a concept page\",\"md\":\"guides/scaffold-concept.md\"}],\"scenarios\":[{\"id\":\"choose-content-type\",\"title\":\"Choose the right Docify content type\",\"md\":\"scenarios/choose-content-type.md\"}],\"decisions\":[],\"glossary\":[{\"id\":\"docify\",\"term\":\"Docify\",\"md\":\"glossary/docify.md\"},{\"id\":\"search-json\",\"term\":\"SEARCH.json\",\"md\":\"glossary/search-json.md\"}],\"visuals\":[],\"diagrams\":[{\"id\":\"docify-dual-audience\",\"title\":\"One library, two consumption surfaces\",\"md\":\"diagrams/docify-dual-audience.md\",\"source\":\"diagrams/sources/docify-dual-audience.mmd\"}],\"relationships\":[{\"id\":\"explicit-to-open-md\",\"type\":\"prerequisiteOf\",\"from\":\"explicit-authoring\",\"to\":\"open-markdown\"},{\"id\":\"types-related\",\"type\":\"relatedTo\",\"from\":\"guide-vs-scenario\",\"to\":\"explicit-authoring\"}],\"tutorials\":[],\"examples\":[],\"sampleData\":[],\"uiClients\":[],\"apis\":[],\"packs\":[{\"id\":\"concept/explicit-authoring\",\"type\":\"concept\",\"path\":\"packs/concept/explicit-authoring\"},{\"id\":\"concept/open-markdown\",\"type\":\"concept\",\"path\":\"packs/concept/open-markdown\"},{\"id\":\"concept/guide-vs-scenario\",\"type\":\"concept\",\"path\":\"packs/concept/guide-vs-scenario\"},{\"id\":\"guide/scaffold-concept\",\"type\":\"guide\",\"path\":\"packs/guide/scaffold-concept\"},{\"id\":\"scenario/choose-content-type\",\"type\":\"scenario\",\"path\":\"packs/scenario/choose-content-type\"}]}",
|
|
1707
|
+
"agent/concepts/explicit-authoring.md": "---\nid: \"explicit-authoring\"\ntype: \"concept\"\ntitle: \"Explicit authoring\"\nsummary: \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\"\nproblem: \"Auto-scanning repositories invents incomplete or wrong documentation.\"\nwhy: \"Accessibility requires intentional explanations, relationships, and confirmation boundaries.\"\nmentalModel: \"Authors understand; Docify packages and presents.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"open-markdown\", \"knowledge-relationships\"]\nnext: [\"open-markdown\"]\n---\n# Explicit authoring\n\nDocify only builds knowledge that authors declare — it never discovers product truth from source.\n\n## Problem\n\nAuto-scanning repositories invents incomplete or wrong documentation.\n\n## Why\n\nAccessibility requires intentional explanations, relationships, and confirmation boundaries.\n\n## Mental model\n\nAuthors understand; Docify packages and presents.\n",
|
|
1708
|
+
"concepts/explicit-authoring.md": "---\nid: \"explicit-authoring\"\ntype: \"concept\"\ntitle: \"Explicit authoring\"\nsummary: \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\"\nproblem: \"Auto-scanning repositories invents incomplete or wrong documentation.\"\nwhy: \"Accessibility requires intentional explanations, relationships, and confirmation boundaries.\"\nmentalModel: \"Authors understand; Docify packages and presents.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"open-markdown\", \"knowledge-relationships\"]\nnext: [\"open-markdown\"]\n---\n# Explicit authoring\n\nDocify only builds knowledge that authors declare — it never discovers product truth from source.\n\n## Problem\n\nAuto-scanning repositories invents incomplete or wrong documentation.\n\n## Why\n\nAccessibility requires intentional explanations, relationships, and confirmation boundaries.\n\n## Mental model\n\nAuthors understand; Docify packages and presents.\n",
|
|
1709
|
+
"agent/concepts/guide-vs-scenario.md": "---\nid: \"guide-vs-scenario\"\ntype: \"concept\"\ntitle: \"Guides vs scenarios vs journeys\"\nsummary: \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\"\nproblem: \"Mixing learning, diagnosis, and production procedures confuses agents and operators.\"\nwhy: \"Clear types keep invariants and confirmation boundaries enforceable.\"\nmentalModel: \"Scenario chooses a guide; journey sequences several guides and decisions.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\"]\n---\n# Guides vs scenarios vs journeys\n\nGuides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n\n## Problem\n\nMixing learning, diagnosis, and production procedures confuses agents and operators.\n\n## Why\n\nClear types keep invariants and confirmation boundaries enforceable.\n\n## Mental model\n\nScenario chooses a guide; journey sequences several guides and decisions.\n",
|
|
1710
|
+
"concepts/guide-vs-scenario.md": "---\nid: \"guide-vs-scenario\"\ntype: \"concept\"\ntitle: \"Guides vs scenarios vs journeys\"\nsummary: \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\"\nproblem: \"Mixing learning, diagnosis, and production procedures confuses agents and operators.\"\nwhy: \"Clear types keep invariants and confirmation boundaries enforceable.\"\nmentalModel: \"Scenario chooses a guide; journey sequences several guides and decisions.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\"]\n---\n# Guides vs scenarios vs journeys\n\nGuides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n\n## Problem\n\nMixing learning, diagnosis, and production procedures confuses agents and operators.\n\n## Why\n\nClear types keep invariants and confirmation boundaries enforceable.\n\n## Mental model\n\nScenario chooses a guide; journey sequences several guides and decisions.\n",
|
|
1711
|
+
"agent/concepts/open-markdown.md": "---\nid: \"open-markdown\"\ntype: \"concept\"\ntitle: \"Open Markdown baseline\"\nsummary: \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\"\nproblem: \"Knowledge trapped in generated JS or HTML blocks offline and agent workflows.\"\nwhy: \"Agents and humans must grep, read, and pack the same facts without executing code.\"\nmentalModel: \"INDEX.md and SEARCH.json are the door; Markdown files are the rooms.\"\naudiences: [\"developers\"]\nrelated: [\"explicit-authoring\"]\nnext: [\"guide-vs-scenario\"]\n---\n# Open Markdown baseline\n\nEvery knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n\n## Problem\n\nKnowledge trapped in generated JS or HTML blocks offline and agent workflows.\n\n## Why\n\nAgents and humans must grep, read, and pack the same facts without executing code.\n\n## Mental model\n\nINDEX.md and SEARCH.json are the door; Markdown files are the rooms.\n",
|
|
1712
|
+
"concepts/open-markdown.md": "---\nid: \"open-markdown\"\ntype: \"concept\"\ntitle: \"Open Markdown baseline\"\nsummary: \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\"\nproblem: \"Knowledge trapped in generated JS or HTML blocks offline and agent workflows.\"\nwhy: \"Agents and humans must grep, read, and pack the same facts without executing code.\"\nmentalModel: \"INDEX.md and SEARCH.json are the door; Markdown files are the rooms.\"\naudiences: [\"developers\"]\nrelated: [\"explicit-authoring\"]\nnext: [\"guide-vs-scenario\"]\n---\n# Open Markdown baseline\n\nEvery knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n\n## Problem\n\nKnowledge trapped in generated JS or HTML blocks offline and agent workflows.\n\n## Why\n\nAgents and humans must grep, read, and pack the same facts without executing code.\n\n## Mental model\n\nINDEX.md and SEARCH.json are the door; Markdown files are the rooms.\n",
|
|
1713
|
+
"agent/diagrams/docify-dual-audience.md": "---\nid: \"docify-dual-audience\"\ntype: \"diagram\"\ntitle: \"One library, two consumption surfaces\"\nsummary: \"Explicitly authored content becomes a human website and an agent knowledge package.\"\nwhy: \"Humans and agents share one source model without forked facts.\"\ndiagramType: \"flow\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\", \"open-markdown\"]\n---\n# One library, two consumption surfaces\n\nExplicitly authored content becomes a human website and an agent knowledge package.\n\n## Why\n\nHumans and agents share one source model without forked facts.\n\n## How to read\n\nFollow arrows from authored sources to human and agent outputs.\n\n## Text alternative\n\nAuthors 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.\n\n## Nodes\n\n- **Authors** (`authors`): Humans or agents write explicit knowledge\n- **Validate** (`validate`): Schemas, links, a11y metadata\n- **Website** (`web`): Human consumption\n- **Agent package** (`agent`): INDEX, SEARCH, Markdown, SDK\n\n## Edges\n\n- authors → validate (declare)\n- validate → web (render)\n- validate → agent (pack)\n\n## Key takeaways\n\n- Authors own product truth\n- Docify never scans the product repository\n- Open Markdown is the agent baseline\n\n## Mermaid source\n\n```mermaid\nflowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n\n```\n",
|
|
1714
|
+
"diagrams/docify-dual-audience.md": "---\nid: \"docify-dual-audience\"\ntype: \"diagram\"\ntitle: \"One library, two consumption surfaces\"\nsummary: \"Explicitly authored content becomes a human website and an agent knowledge package.\"\nwhy: \"Humans and agents share one source model without forked facts.\"\ndiagramType: \"flow\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\", \"open-markdown\"]\n---\n# One library, two consumption surfaces\n\nExplicitly authored content becomes a human website and an agent knowledge package.\n\n## Why\n\nHumans and agents share one source model without forked facts.\n\n## How to read\n\nFollow arrows from authored sources to human and agent outputs.\n\n## Text alternative\n\nAuthors 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.\n\n## Nodes\n\n- **Authors** (`authors`): Humans or agents write explicit knowledge\n- **Validate** (`validate`): Schemas, links, a11y metadata\n- **Website** (`web`): Human consumption\n- **Agent package** (`agent`): INDEX, SEARCH, Markdown, SDK\n\n## Edges\n\n- authors → validate (declare)\n- validate → web (render)\n- validate → agent (pack)\n\n## Key takeaways\n\n- Authors own product truth\n- Docify never scans the product repository\n- Open Markdown is the agent baseline\n\n## Mermaid source\n\n```mermaid\nflowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n\n```\n",
|
|
1715
|
+
"agent/diagrams/sources/docify-dual-audience.mmd": "flowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n",
|
|
1716
|
+
"diagrams/sources/docify-dual-audience.mmd": "flowchart LR\n authors[Authors] --> validate[Validate]\n validate --> web[Website]\n validate --> agent[Agent package]\n",
|
|
1717
|
+
"agent/glossary/docify.md": "---\nid: \"docify\"\ntype: \"glossary-term\"\ntitle: \"Docify\"\nsummary: \"x12i framework that turns explicitly authored product knowledge into a website and agent package.\"\naliases: [\"x12i-docify\"]\n---\n# Docify\n\nx12i framework that turns explicitly authored product knowledge into a website and agent package.\n",
|
|
1718
|
+
"glossary/docify.md": "---\nid: \"docify\"\ntype: \"glossary-term\"\ntitle: \"Docify\"\nsummary: \"x12i framework that turns explicitly authored product knowledge into a website and agent package.\"\naliases: [\"x12i-docify\"]\n---\n# Docify\n\nx12i framework that turns explicitly authored product knowledge into a website and agent package.\n",
|
|
1719
|
+
"agent/glossary/search-json.md": "---\nid: \"search-json\"\ntype: \"glossary-term\"\ntitle: \"SEARCH.json\"\nsummary: \"Deterministic local search index over all addressable knowledge items.\"\naliases: [\"search index\"]\n---\n# SEARCH.json\n\nDeterministic local search index over all addressable knowledge items.\n",
|
|
1720
|
+
"glossary/search-json.md": "---\nid: \"search-json\"\ntype: \"glossary-term\"\ntitle: \"SEARCH.json\"\nsummary: \"Deterministic local search index over all addressable knowledge items.\"\naliases: [\"search index\"]\n---\n# SEARCH.json\n\nDeterministic local search index over all addressable knowledge items.\n",
|
|
1721
|
+
"agent/guides/scaffold-concept.md": "---\nid: \"scaffold-concept\"\ntype: \"guide\"\ntitle: \"Scaffold a concept page\"\nsummary: \"Create a validated concept with problem, why, and mental model.\"\nwhy: \"Concepts without why become unusable glossary stubs.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\"]\ninvariants: [\"Docify does not invent the concept from source code\"]\nconfirmationRequired: false\n---\n# Scaffold a concept page\n\nCreate a validated concept with problem, why, and mental model.\n\n## Why this path\n\nConcepts without why become unusable glossary stubs.\n\n## Use this when\n\n- Documenting a product idea that needs explanation first\n\n## Do not use this when\n\n- Writing a step-by-step production procedure (use a guide)\n\n## Invariants\n\n- Docify does not invent the concept from source code\n\n## Steps\n\n1. **Run docify scaffold concept <id>** — Markdown file under concepts/\n2. **Fill summary, problem, why, mental model** — Human-understanding fields present\n3. **Run docify validate** — Validation passes\n\n## Verification\n\n- Concept appears in INDEX.md after build\n",
|
|
1722
|
+
"guides/scaffold-concept.md": "---\nid: \"scaffold-concept\"\ntype: \"guide\"\ntitle: \"Scaffold a concept page\"\nsummary: \"Create a validated concept with problem, why, and mental model.\"\nwhy: \"Concepts without why become unusable glossary stubs.\"\naudiences: [\"developers\", \"builders\"]\nrelated: [\"explicit-authoring\"]\ninvariants: [\"Docify does not invent the concept from source code\"]\nconfirmationRequired: false\n---\n# Scaffold a concept page\n\nCreate a validated concept with problem, why, and mental model.\n\n## Why this path\n\nConcepts without why become unusable glossary stubs.\n\n## Use this when\n\n- Documenting a product idea that needs explanation first\n\n## Do not use this when\n\n- Writing a step-by-step production procedure (use a guide)\n\n## Invariants\n\n- Docify does not invent the concept from source code\n\n## Steps\n\n1. **Run docify scaffold concept <id>** — Markdown file under concepts/\n2. **Fill summary, problem, why, mental model** — Human-understanding fields present\n3. **Run docify validate** — Validation passes\n\n## Verification\n\n- Concept appears in INDEX.md after build\n",
|
|
1723
|
+
"agent/indexes/books.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"00-platform-overview\",\n \"title\": \"Platform Overview\",\n \"summary\": \"What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\",\n \"path\": \"books/00-platform-overview/\"\n },\n {\n \"id\": \"01-packages\",\n \"title\": \"Packages\",\n \"summary\": \"Core, theme, render, export, SDK, web, and screenshots — what each package owns.\",\n \"path\": \"books/01-packages/\"\n },\n {\n \"id\": \"02-authoring\",\n \"title\": \"Authoring a Library\",\n \"summary\": \"Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\",\n \"path\": \"books/02-authoring/\"\n },\n {\n \"id\": \"03-for-humans\",\n \"title\": \"For Humans\",\n \"summary\": \"How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\",\n \"path\": \"books/03-for-humans/\"\n },\n {\n \"id\": \"04-for-agents\",\n \"title\": \"For Agents\",\n \"summary\": \"MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\",\n \"path\": \"books/04-for-agents/\"\n },\n {\n \"id\": \"05-design\",\n \"title\": \"Design System\",\n \"summary\": \"Shared theme tokens and surfaces — products change naming and content only.\",\n \"path\": \"books/05-design/\"\n },\n {\n \"id\": \"06-getting-started-and-tutorials\",\n \"title\": \"Getting Started & Tutorials\",\n \"summary\": \"Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\",\n \"path\": \"books/06-getting-started-and-tutorials/\"\n }\n ]\n}",
|
|
1724
|
+
"indexes/books.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"00-platform-overview\",\n \"title\": \"Platform Overview\",\n \"summary\": \"What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\",\n \"path\": \"books/00-platform-overview/\"\n },\n {\n \"id\": \"01-packages\",\n \"title\": \"Packages\",\n \"summary\": \"Core, theme, render, export, SDK, web, and screenshots — what each package owns.\",\n \"path\": \"books/01-packages/\"\n },\n {\n \"id\": \"02-authoring\",\n \"title\": \"Authoring a Library\",\n \"summary\": \"Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\",\n \"path\": \"books/02-authoring/\"\n },\n {\n \"id\": \"03-for-humans\",\n \"title\": \"For Humans\",\n \"summary\": \"How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\",\n \"path\": \"books/03-for-humans/\"\n },\n {\n \"id\": \"04-for-agents\",\n \"title\": \"For Agents\",\n \"summary\": \"MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\",\n \"path\": \"books/04-for-agents/\"\n },\n {\n \"id\": \"05-design\",\n \"title\": \"Design System\",\n \"summary\": \"Shared theme tokens and surfaces — products change naming and content only.\",\n \"path\": \"books/05-design/\"\n },\n {\n \"id\": \"06-getting-started-and-tutorials\",\n \"title\": \"Getting Started & Tutorials\",\n \"summary\": \"Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\",\n \"path\": \"books/06-getting-started-and-tutorials/\"\n }\n ]\n}",
|
|
1725
|
+
"agent/indexes/books.md": "# books\n\n- `00-platform-overview` — Platform Overview — What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\n- `01-packages` — Packages — Core, theme, render, export, SDK, web, and screenshots — what each package owns.\n- `02-authoring` — Authoring a Library — Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\n- `03-for-humans` — For Humans — How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\n- `04-for-agents` — For Agents — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n- `05-design` — Design System — Shared theme tokens and surfaces — products change naming and content only.\n- `06-getting-started-and-tutorials` — Getting Started & Tutorials — Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\n",
|
|
1726
|
+
"indexes/books.md": "# books\n\n- `00-platform-overview` — Platform Overview — What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\n- `01-packages` — Packages — Core, theme, render, export, SDK, web, and screenshots — what each package owns.\n- `02-authoring` — Authoring a Library — Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\n- `03-for-humans` — For Humans — How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\n- `04-for-agents` — For Agents — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n- `05-design` — Design System — Shared theme tokens and surfaces — products change naming and content only.\n- `06-getting-started-and-tutorials` — Getting Started & Tutorials — Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\n",
|
|
1727
|
+
"agent/indexes/concepts.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"explicit-authoring\",\n \"title\": \"Explicit authoring\",\n \"summary\": \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\n \"path\": \"concepts/explicit-authoring.md\"\n },\n {\n \"id\": \"open-markdown\",\n \"title\": \"Open Markdown baseline\",\n \"summary\": \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\n \"path\": \"concepts/open-markdown.md\"\n },\n {\n \"id\": \"guide-vs-scenario\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"summary\": \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\n \"path\": \"concepts/guide-vs-scenario.md\"\n }\n ]\n}",
|
|
1728
|
+
"indexes/concepts.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"explicit-authoring\",\n \"title\": \"Explicit authoring\",\n \"summary\": \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\n \"path\": \"concepts/explicit-authoring.md\"\n },\n {\n \"id\": \"open-markdown\",\n \"title\": \"Open Markdown baseline\",\n \"summary\": \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\n \"path\": \"concepts/open-markdown.md\"\n },\n {\n \"id\": \"guide-vs-scenario\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"summary\": \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\n \"path\": \"concepts/guide-vs-scenario.md\"\n }\n ]\n}",
|
|
1729
|
+
"agent/indexes/concepts.md": "# concepts\n\n- `explicit-authoring` — Explicit authoring — Docify only builds knowledge that authors declare — it never discovers product truth from source.\n- `open-markdown` — Open Markdown baseline — Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n- `guide-vs-scenario` — Guides vs scenarios vs journeys — Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n",
|
|
1730
|
+
"indexes/concepts.md": "# concepts\n\n- `explicit-authoring` — Explicit authoring — Docify only builds knowledge that authors declare — it never discovers product truth from source.\n- `open-markdown` — Open Markdown baseline — Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n- `guide-vs-scenario` — Guides vs scenarios vs journeys — Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n",
|
|
1731
|
+
"agent/indexes/diagrams.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"docify-dual-audience\",\n \"title\": \"One library, two consumption surfaces\",\n \"summary\": \"Explicitly authored content becomes a human website and an agent knowledge package.\",\n \"path\": \"diagrams/docify-dual-audience.md\"\n }\n ]\n}",
|
|
1732
|
+
"indexes/diagrams.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"docify-dual-audience\",\n \"title\": \"One library, two consumption surfaces\",\n \"summary\": \"Explicitly authored content becomes a human website and an agent knowledge package.\",\n \"path\": \"diagrams/docify-dual-audience.md\"\n }\n ]\n}",
|
|
1733
|
+
"agent/indexes/diagrams.md": "# diagrams\n\n- `docify-dual-audience` — One library, two consumption surfaces — Explicitly authored content becomes a human website and an agent knowledge package.\n",
|
|
1734
|
+
"indexes/diagrams.md": "# diagrams\n\n- `docify-dual-audience` — One library, two consumption surfaces — Explicitly authored content becomes a human website and an agent knowledge package.\n",
|
|
1735
|
+
"agent/indexes/guides.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"scaffold-concept\",\n \"title\": \"Scaffold a concept page\",\n \"summary\": \"Create a validated concept with problem, why, and mental model.\",\n \"path\": \"guides/scaffold-concept.md\"\n }\n ]\n}",
|
|
1736
|
+
"indexes/guides.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"scaffold-concept\",\n \"title\": \"Scaffold a concept page\",\n \"summary\": \"Create a validated concept with problem, why, and mental model.\",\n \"path\": \"guides/scaffold-concept.md\"\n }\n ]\n}",
|
|
1737
|
+
"agent/indexes/guides.md": "# guides\n\n- `scaffold-concept` — Scaffold a concept page — Create a validated concept with problem, why, and mental model.\n",
|
|
1738
|
+
"indexes/guides.md": "# guides\n\n- `scaffold-concept` — Scaffold a concept page — Create a validated concept with problem, why, and mental model.\n",
|
|
1739
|
+
"agent/indexes/scenarios.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"choose-content-type\",\n \"title\": \"Choose the right Docify content type\",\n \"summary\": \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\n \"path\": \"scenarios/choose-content-type.md\"\n }\n ]\n}",
|
|
1740
|
+
"indexes/scenarios.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"choose-content-type\",\n \"title\": \"Choose the right Docify content type\",\n \"summary\": \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\n \"path\": \"scenarios/choose-content-type.md\"\n }\n ]\n}",
|
|
1741
|
+
"agent/indexes/scenarios.md": "# scenarios\n\n- `choose-content-type` — Choose the right Docify content type — Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\n",
|
|
1742
|
+
"indexes/scenarios.md": "# scenarios\n\n- `choose-content-type` — Choose the right Docify content type — Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\n",
|
|
1743
|
+
"agent/indexes/tutorials.json": "{\n \"version\": 1,\n \"items\": []\n}",
|
|
1744
|
+
"indexes/tutorials.json": "{\n \"version\": 1,\n \"items\": []\n}",
|
|
1745
|
+
"agent/indexes/tutorials.md": "# tutorials\n\n\n",
|
|
1746
|
+
"indexes/tutorials.md": "# tutorials\n\n\n",
|
|
1747
|
+
"agent/indexes/use-cases.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"orient-docify\",\n \"title\": \"Orient on x12i-docify\",\n \"summary\": \"Understand the dual-audience platform and where product libraries fit.\",\n \"path\": \"use-cases/orient-docify.md\"\n },\n {\n \"id\": \"map-packages\",\n \"title\": \"Map the @x12i/docify-* packages\",\n \"summary\": \"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\",\n \"path\": \"use-cases/map-packages.md\"\n },\n {\n \"id\": \"wire-product-library\",\n \"title\": \"Wire a product docs library\",\n \"summary\": \"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\",\n \"path\": \"use-cases/wire-product-library.md\"\n },\n {\n \"id\": \"ship-human-site\",\n \"title\": \"Ship the human web app\",\n \"summary\": \"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\",\n \"path\": \"use-cases/ship-human-site.md\"\n },\n {\n \"id\": \"ship-agent-packs\",\n \"title\": \"Ship agent markdown and knowledge SDK\",\n \"summary\": \"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\",\n \"path\": \"use-cases/ship-agent-packs.md\"\n },\n {\n \"id\": \"keep-one-design\",\n \"title\": \"Keep one design system\",\n \"summary\": \"Change product naming and content only — never fork theme or invent a competing palette.\",\n \"path\": \"use-cases/keep-one-design.md\"\n }\n ]\n}",
|
|
1748
|
+
"indexes/use-cases.json": "{\n \"version\": 1,\n \"items\": [\n {\n \"id\": \"orient-docify\",\n \"title\": \"Orient on x12i-docify\",\n \"summary\": \"Understand the dual-audience platform and where product libraries fit.\",\n \"path\": \"use-cases/orient-docify.md\"\n },\n {\n \"id\": \"map-packages\",\n \"title\": \"Map the @x12i/docify-* packages\",\n \"summary\": \"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\",\n \"path\": \"use-cases/map-packages.md\"\n },\n {\n \"id\": \"wire-product-library\",\n \"title\": \"Wire a product docs library\",\n \"summary\": \"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\",\n \"path\": \"use-cases/wire-product-library.md\"\n },\n {\n \"id\": \"ship-human-site\",\n \"title\": \"Ship the human web app\",\n \"summary\": \"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\",\n \"path\": \"use-cases/ship-human-site.md\"\n },\n {\n \"id\": \"ship-agent-packs\",\n \"title\": \"Ship agent markdown and knowledge SDK\",\n \"summary\": \"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\",\n \"path\": \"use-cases/ship-agent-packs.md\"\n },\n {\n \"id\": \"keep-one-design\",\n \"title\": \"Keep one design system\",\n \"summary\": \"Change product naming and content only — never fork theme or invent a competing palette.\",\n \"path\": \"use-cases/keep-one-design.md\"\n }\n ]\n}",
|
|
1749
|
+
"agent/indexes/use-cases.md": "# use-cases\n\n- `orient-docify` — Orient on x12i-docify — Understand the dual-audience platform and where product libraries fit.\n- `map-packages` — Map the @x12i/docify-* packages — Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\n- `wire-product-library` — Wire a product docs library — Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\n- `ship-human-site` — Ship the human web app — Build and serve dist/web with roles, use cases, catalog, and chapter reader.\n- `ship-agent-packs` — Ship agent markdown and knowledge SDK — Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n- `keep-one-design` — Keep one design system — Change product naming and content only — never fork theme or invent a competing palette.\n",
|
|
1750
|
+
"indexes/use-cases.md": "# use-cases\n\n- `orient-docify` — Orient on x12i-docify — Understand the dual-audience platform and where product libraries fit.\n- `map-packages` — Map the @x12i/docify-* packages — Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\n- `wire-product-library` — Wire a product docs library — Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\n- `ship-human-site` — Ship the human web app — Build and serve dist/web with roles, use cases, catalog, and chapter reader.\n- `ship-agent-packs` — Ship agent markdown and knowledge SDK — Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n- `keep-one-design` — Keep one design system — Change product naming and content only — never fork theme or invent a competing palette.\n",
|
|
1751
|
+
"agent/packs/concept/explicit-authoring/PACK.md": "---\nid: \"concept/explicit-authoring\"\ntype: \"pack\"\ntitle: \"Explicit authoring\"\nsummary: \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\"\n---\n# Pack: Explicit authoring\n\nDocify only builds knowledge that authors declare — it never discovers product truth from source.\n\nPrimary markdown: `concepts/explicit-authoring.md`\n",
|
|
1752
|
+
"packs/concept/explicit-authoring/PACK.md": "---\nid: \"concept/explicit-authoring\"\ntype: \"pack\"\ntitle: \"Explicit authoring\"\nsummary: \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\"\n---\n# Pack: Explicit authoring\n\nDocify only builds knowledge that authors declare — it never discovers product truth from source.\n\nPrimary markdown: `concepts/explicit-authoring.md`\n",
|
|
1753
|
+
"agent/packs/concept/explicit-authoring/pack.json": "{\n \"id\": \"concept/explicit-authoring\",\n \"type\": \"concept\",\n \"title\": \"Explicit authoring\",\n \"summary\": \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\n \"markdownPath\": \"concepts/explicit-authoring.md\",\n \"files\": [\n \"concepts/explicit-authoring.md\"\n ],\n \"related\": [\n \"open-markdown\",\n \"knowledge-relationships\"\n ]\n}",
|
|
1754
|
+
"packs/concept/explicit-authoring/pack.json": "{\n \"id\": \"concept/explicit-authoring\",\n \"type\": \"concept\",\n \"title\": \"Explicit authoring\",\n \"summary\": \"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\n \"markdownPath\": \"concepts/explicit-authoring.md\",\n \"files\": [\n \"concepts/explicit-authoring.md\"\n ],\n \"related\": [\n \"open-markdown\",\n \"knowledge-relationships\"\n ]\n}",
|
|
1755
|
+
"agent/packs/concept/guide-vs-scenario/PACK.md": "---\nid: \"concept/guide-vs-scenario\"\ntype: \"pack\"\ntitle: \"Guides vs scenarios vs journeys\"\nsummary: \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\"\n---\n# Pack: Guides vs scenarios vs journeys\n\nGuides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n\nPrimary markdown: `concepts/guide-vs-scenario.md`\n",
|
|
1756
|
+
"packs/concept/guide-vs-scenario/PACK.md": "---\nid: \"concept/guide-vs-scenario\"\ntype: \"pack\"\ntitle: \"Guides vs scenarios vs journeys\"\nsummary: \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\"\n---\n# Pack: Guides vs scenarios vs journeys\n\nGuides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\n\nPrimary markdown: `concepts/guide-vs-scenario.md`\n",
|
|
1757
|
+
"agent/packs/concept/guide-vs-scenario/pack.json": "{\n \"id\": \"concept/guide-vs-scenario\",\n \"type\": \"concept\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"summary\": \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\n \"markdownPath\": \"concepts/guide-vs-scenario.md\",\n \"files\": [\n \"concepts/guide-vs-scenario.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1758
|
+
"packs/concept/guide-vs-scenario/pack.json": "{\n \"id\": \"concept/guide-vs-scenario\",\n \"type\": \"concept\",\n \"title\": \"Guides vs scenarios vs journeys\",\n \"summary\": \"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\n \"markdownPath\": \"concepts/guide-vs-scenario.md\",\n \"files\": [\n \"concepts/guide-vs-scenario.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1759
|
+
"agent/packs/concept/open-markdown/PACK.md": "---\nid: \"concept/open-markdown\"\ntype: \"pack\"\ntitle: \"Open Markdown baseline\"\nsummary: \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\"\n---\n# Pack: Open Markdown baseline\n\nEvery knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n\nPrimary markdown: `concepts/open-markdown.md`\n",
|
|
1760
|
+
"packs/concept/open-markdown/PACK.md": "---\nid: \"concept/open-markdown\"\ntype: \"pack\"\ntitle: \"Open Markdown baseline\"\nsummary: \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\"\n---\n# Pack: Open Markdown baseline\n\nEvery knowledge item ships as readable Markdown plus indexes — the SDK is optional.\n\nPrimary markdown: `concepts/open-markdown.md`\n",
|
|
1761
|
+
"agent/packs/concept/open-markdown/pack.json": "{\n \"id\": \"concept/open-markdown\",\n \"type\": \"concept\",\n \"title\": \"Open Markdown baseline\",\n \"summary\": \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\n \"markdownPath\": \"concepts/open-markdown.md\",\n \"files\": [\n \"concepts/open-markdown.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1762
|
+
"packs/concept/open-markdown/pack.json": "{\n \"id\": \"concept/open-markdown\",\n \"type\": \"concept\",\n \"title\": \"Open Markdown baseline\",\n \"summary\": \"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\n \"markdownPath\": \"concepts/open-markdown.md\",\n \"files\": [\n \"concepts/open-markdown.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1763
|
+
"agent/packs/guide/scaffold-concept/PACK.md": "---\nid: \"guide/scaffold-concept\"\ntype: \"pack\"\ntitle: \"Scaffold a concept page\"\nsummary: \"Create a validated concept with problem, why, and mental model.\"\n---\n# Pack: Scaffold a concept page\n\nCreate a validated concept with problem, why, and mental model.\n\nPrimary markdown: `guides/scaffold-concept.md`\n",
|
|
1764
|
+
"packs/guide/scaffold-concept/PACK.md": "---\nid: \"guide/scaffold-concept\"\ntype: \"pack\"\ntitle: \"Scaffold a concept page\"\nsummary: \"Create a validated concept with problem, why, and mental model.\"\n---\n# Pack: Scaffold a concept page\n\nCreate a validated concept with problem, why, and mental model.\n\nPrimary markdown: `guides/scaffold-concept.md`\n",
|
|
1765
|
+
"agent/packs/guide/scaffold-concept/pack.json": "{\n \"id\": \"guide/scaffold-concept\",\n \"type\": \"guide\",\n \"title\": \"Scaffold a concept page\",\n \"summary\": \"Create a validated concept with problem, why, and mental model.\",\n \"markdownPath\": \"guides/scaffold-concept.md\",\n \"files\": [\n \"guides/scaffold-concept.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1766
|
+
"packs/guide/scaffold-concept/pack.json": "{\n \"id\": \"guide/scaffold-concept\",\n \"type\": \"guide\",\n \"title\": \"Scaffold a concept page\",\n \"summary\": \"Create a validated concept with problem, why, and mental model.\",\n \"markdownPath\": \"guides/scaffold-concept.md\",\n \"files\": [\n \"guides/scaffold-concept.md\"\n ],\n \"related\": [\n \"explicit-authoring\"\n ]\n}",
|
|
1767
|
+
"agent/packs/scenario/choose-content-type/PACK.md": "---\nid: \"scenario/choose-content-type\"\ntype: \"pack\"\ntitle: \"Choose the right Docify content type\"\nsummary: \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\"\n---\n# Pack: Choose the right Docify content type\n\nPick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\n\nPrimary markdown: `scenarios/choose-content-type.md`\n",
|
|
1768
|
+
"packs/scenario/choose-content-type/PACK.md": "---\nid: \"scenario/choose-content-type\"\ntype: \"pack\"\ntitle: \"Choose the right Docify content type\"\nsummary: \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\"\n---\n# Pack: Choose the right Docify content type\n\nPick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\n\nPrimary markdown: `scenarios/choose-content-type.md`\n",
|
|
1769
|
+
"agent/packs/scenario/choose-content-type/pack.json": "{\n \"id\": \"scenario/choose-content-type\",\n \"type\": \"scenario\",\n \"title\": \"Choose the right Docify content type\",\n \"summary\": \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\n \"markdownPath\": \"scenarios/choose-content-type.md\",\n \"files\": [\n \"scenarios/choose-content-type.md\"\n ],\n \"related\": []\n}",
|
|
1770
|
+
"packs/scenario/choose-content-type/pack.json": "{\n \"id\": \"scenario/choose-content-type\",\n \"type\": \"scenario\",\n \"title\": \"Choose the right Docify content type\",\n \"summary\": \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\n \"markdownPath\": \"scenarios/choose-content-type.md\",\n \"files\": [\n \"scenarios/choose-content-type.md\"\n ],\n \"related\": []\n}",
|
|
1771
|
+
"agent/scenarios/choose-content-type.md": "---\nid: \"choose-content-type\"\ntype: \"scenario\"\ntitle: \"Choose the right Docify content type\"\nsummary: \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\"\naudiences: [\"developers\", \"builders\"]\ninvariants: [\"Do not invent unsupported actions from a broad why statement\"]\n---\n# Choose the right Docify content type\n\n## Situation\n\nAn agent is asked to document a product behavior and is unsure which file to create.\n\n## Decision\n\nWhich Docify content type fits this goal?\n\n## Signals\n\n- Need a definition and why\n- Need a bounded production procedure\n- Need branching on observed state\n- Need safe rehearsal with sample data\n\n## Paths\n\n### Author a concept\n\n**When:** The reader needs what it is and why it exists\n\nConcepts carry mental models before procedures.\n\nGuides: `scaffold-concept`\n\n### Author a guide\n\n**When:** The reader needs a bounded task with verification\n\nGuides are normative procedures with confirmation boundaries.\n\nGuides: `scaffold-concept`\n\n### Author a tutorial\n\n**When:** The goal is learning with sample data and reset\n\nTutorials teach; production guides remain usable without them.\n\nGuides: _none_\n\n## Escalation\n\nIf product truth is unclear, stop and ask the product owners — do not infer from source.\n",
|
|
1772
|
+
"scenarios/choose-content-type.md": "---\nid: \"choose-content-type\"\ntype: \"scenario\"\ntitle: \"Choose the right Docify content type\"\nsummary: \"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\"\naudiences: [\"developers\", \"builders\"]\ninvariants: [\"Do not invent unsupported actions from a broad why statement\"]\n---\n# Choose the right Docify content type\n\n## Situation\n\nAn agent is asked to document a product behavior and is unsure which file to create.\n\n## Decision\n\nWhich Docify content type fits this goal?\n\n## Signals\n\n- Need a definition and why\n- Need a bounded production procedure\n- Need branching on observed state\n- Need safe rehearsal with sample data\n\n## Paths\n\n### Author a concept\n\n**When:** The reader needs what it is and why it exists\n\nConcepts carry mental models before procedures.\n\nGuides: `scaffold-concept`\n\n### Author a guide\n\n**When:** The reader needs a bounded task with verification\n\nGuides are normative procedures with confirmation boundaries.\n\nGuides: `scaffold-concept`\n\n### Author a tutorial\n\n**When:** The goal is learning with sample data and reset\n\nTutorials teach; production guides remain usable without them.\n\nGuides: _none_\n\n## Escalation\n\nIf product truth is unclear, stop and ask the product owners — do not infer from source.\n",
|
|
1773
|
+
"agent/use-cases/keep-one-design.md": "# Keep one design system\n\n> **Use case id:** `keep-one-design`\n> **Goal:** Change product naming and content only — never fork theme or invent a competing palette.\n> **Audiences:** developers, builders\n> **Tags:** design, theme\n\n## Reading path\n\n1. **Design System** (builders) → chapters: `1-principle`, `2-identity`, `3-surfaces`, `4-do-not`\n\n## From: Design System — 1. Principle\n\n**One design system.** You change **words, books, and brand strings** — not layout, cards chrome, or a new palette.\n\n---\n\n## From: Design System — 2. Identity\n\nThe site already carries IBM Plex, neutral surfaces, and a primary + builders accent. Catalog **book colors** are case-file accents inside that system, not a free-for-all.\n\n---\n\n## From: Design System — 3. Surfaces\n\n| Surface | What you influence |\n|---|---|\n| Product / docs chrome | Site-page copy, CTAs, featured book ids |\n| Chapter reader | Markdown structure and diagrams inside books |\n| Catalog cards | Title, blurb, kicker, color field in `catalog.json` |\n\n---\n\n## From: Design System — 4. Do not\n\n- Ask engineering to fork theme CSS “just for this product”\n- Overload the first viewport with secondary marketing blocks (follow product-home patterns)\n- Treat screenshots as decoration without a shot-list purpose\n\n## Also see\n\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1774
|
+
"use-cases/keep-one-design.md": "# Keep one design system\n\n> **Use case id:** `keep-one-design`\n> **Goal:** Change product naming and content only — never fork theme or invent a competing palette.\n> **Audiences:** developers, builders\n> **Tags:** design, theme\n\n## Reading path\n\n1. **Design System** (builders) → chapters: `1-principle`, `2-identity`, `3-surfaces`, `4-do-not`\n\n## From: Design System — 1. Principle\n\n**One design system.** You change **words, books, and brand strings** — not layout, cards chrome, or a new palette.\n\n---\n\n## From: Design System — 2. Identity\n\nThe site already carries IBM Plex, neutral surfaces, and a primary + builders accent. Catalog **book colors** are case-file accents inside that system, not a free-for-all.\n\n---\n\n## From: Design System — 3. Surfaces\n\n| Surface | What you influence |\n|---|---|\n| Product / docs chrome | Site-page copy, CTAs, featured book ids |\n| Chapter reader | Markdown structure and diagrams inside books |\n| Catalog cards | Title, blurb, kicker, color field in `catalog.json` |\n\n---\n\n## From: Design System — 4. Do not\n\n- Ask engineering to fork theme CSS “just for this product”\n- Overload the first viewport with secondary marketing blocks (follow product-home patterns)\n- Treat screenshots as decoration without a shot-list purpose\n\n## Also see\n\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1775
|
+
"agent/use-cases/map-packages.md": "# Map the @x12i/docify-* packages\n\n> **Use case id:** `map-packages`\n> **Goal:** Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\n> **Audiences:** developers\n> **Tags:** packages, npm\n\n## Reading path\n\n1. **Packages** (developers) → chapters: `1-package-table`, `2-dependency-shape`, `3-publish-and-install`\n\n## From: Packages — 1. Package table\n\n| Folder | npm | Role |\n|---|---|---|\n| `docify-core` | `@x12i/docify-core` | Catalog / use-case / site-page / manifest schemas + loaders |\n| `docify-theme` | `@x12i/docify-theme` | Shared site + reader CSS (tokens, site, book, extras) |\n| `docify-render` | `@x12i/docify-render` | `BOOK.md` + site-pages → HTML; chapter extract / splice |\n| `docify-export` | `@x12i/docify-export` | Content bundle builder (downloads, landings, agent-manifest) |\n| `docify-sdk` | `@x12i/docify-sdk` | `createEbooksSdk(bundle)` knowledge SDK factory |\n| `docify-web` | `@x12i/docify-web` | Shareable static web app + `docify-web serve` |\n| `docify-screenshots` | `@x12i/docify-screenshots` | Shot lists, placeholders, capture helpers |\n| `docify` | `@x12i/docify` | Platform docs knowledge SDK (dogfood — docs of docify itself) |\n\n---\n\n## From: Packages — 2. Dependency shape\n\n```mermaid\nflowchart LR\n Core[docify-core]\n Theme[docify-theme]\n Render[docify-render]\n Export[docify-export]\n Sdk[docify-sdk]\n Web[docify-web]\n Shots[docify-screenshots]\n Dogfood[\"@x12i/docify\"]\n Render --> Core\n Export --> Core\n Export --> Render\n Sdk --> Core\n Web --> Theme\n ProductDocs[product-docs build] --> Export\n ProductDocs --> Web\n ProductSdk[\"@…-docs\"] --> Sdk\n Dogfood --> Sdk\n```\n\n- **Humans** consume `docify-web` + theme assets from the assembled `dist/web`.\n- **Agents** consume MD packs from the bundle and/or a published product knowledge SDK built on `docify-sdk`.\n- **`@x12i/docify`** is this platform’s own knowledge SDK (docs of docify).\n\n---\n\n## From: Packages — 3. Publish and install\n\nFrom the monorepo (uses root `.npmrc`):\n\n```bash\nbash scripts/publish-docify.sh\n```\n\nTypical product install:\n\n```bash\nnpm i @x12i/docify-core @x12i/docify-theme @x12i/docify-render \\\n @x12i/docify-export @x12i/docify-sdk @x12i/docify-web\nnpm i -D @x12i/docify # this platform’s docs knowledge SDK\nnpm i -D @x12i/memorix-docs # example product knowledge SDK\n```\n\nIn this monorepo, product builds usually **import from source** under `x12i-docify/packages/*/dist` rather than resolving published tarballs during local `npm run docs`.\n\n---\n\n## Also see\n\n- **Packages** (`01-packages`) — Core, theme, render, export, SDK, web, and screenshots — what each package owns.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1776
|
+
"use-cases/map-packages.md": "# Map the @x12i/docify-* packages\n\n> **Use case id:** `map-packages`\n> **Goal:** Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\n> **Audiences:** developers\n> **Tags:** packages, npm\n\n## Reading path\n\n1. **Packages** (developers) → chapters: `1-package-table`, `2-dependency-shape`, `3-publish-and-install`\n\n## From: Packages — 1. Package table\n\n| Folder | npm | Role |\n|---|---|---|\n| `docify-core` | `@x12i/docify-core` | Catalog / use-case / site-page / manifest schemas + loaders |\n| `docify-theme` | `@x12i/docify-theme` | Shared site + reader CSS (tokens, site, book, extras) |\n| `docify-render` | `@x12i/docify-render` | `BOOK.md` + site-pages → HTML; chapter extract / splice |\n| `docify-export` | `@x12i/docify-export` | Content bundle builder (downloads, landings, agent-manifest) |\n| `docify-sdk` | `@x12i/docify-sdk` | `createEbooksSdk(bundle)` knowledge SDK factory |\n| `docify-web` | `@x12i/docify-web` | Shareable static web app + `docify-web serve` |\n| `docify-screenshots` | `@x12i/docify-screenshots` | Shot lists, placeholders, capture helpers |\n| `docify` | `@x12i/docify` | Platform docs knowledge SDK (dogfood — docs of docify itself) |\n\n---\n\n## From: Packages — 2. Dependency shape\n\n```mermaid\nflowchart LR\n Core[docify-core]\n Theme[docify-theme]\n Render[docify-render]\n Export[docify-export]\n Sdk[docify-sdk]\n Web[docify-web]\n Shots[docify-screenshots]\n Dogfood[\"@x12i/docify\"]\n Render --> Core\n Export --> Core\n Export --> Render\n Sdk --> Core\n Web --> Theme\n ProductDocs[product-docs build] --> Export\n ProductDocs --> Web\n ProductSdk[\"@…-docs\"] --> Sdk\n Dogfood --> Sdk\n```\n\n- **Humans** consume `docify-web` + theme assets from the assembled `dist/web`.\n- **Agents** consume MD packs from the bundle and/or a published product knowledge SDK built on `docify-sdk`.\n- **`@x12i/docify`** is this platform’s own knowledge SDK (docs of docify).\n\n---\n\n## From: Packages — 3. Publish and install\n\nFrom the monorepo (uses root `.npmrc`):\n\n```bash\nbash scripts/publish-docify.sh\n```\n\nTypical product install:\n\n```bash\nnpm i @x12i/docify-core @x12i/docify-theme @x12i/docify-render \\\n @x12i/docify-export @x12i/docify-sdk @x12i/docify-web\nnpm i -D @x12i/docify # this platform’s docs knowledge SDK\nnpm i -D @x12i/memorix-docs # example product knowledge SDK\n```\n\nIn this monorepo, product builds usually **import from source** under `x12i-docify/packages/*/dist` rather than resolving published tarballs during local `npm run docs`.\n\n---\n\n## Also see\n\n- **Packages** (`01-packages`) — Core, theme, render, export, SDK, web, and screenshots — what each package owns.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1777
|
+
"agent/use-cases/orient-docify.md": "# Orient on x12i-docify\n\n> **Use case id:** `orient-docify`\n> **Goal:** Understand the dual-audience platform and where product libraries fit.\n> **Audiences:** developers, builders\n> **Tags:** platform, start-here\n\n## Reading path\n\n1. **Platform Overview** (developers) → chapters: `the-central-idea`, `1-what-x12i-docify-is`, `2-layers`, `4-where-to-go-next`\n\n## From: Platform Overview — The central idea\n\n**x12i-docify** is the reusable **product site + docs + knowledge packs** platform for x12i monorepos.\n\n> One content library (`BOOK.md` + use cases). Two consumption surfaces. Same design system everywhere — products change naming and content only.\n\n| Audience | Best form | What we ship |\n|---|---|---|\n| **Humans** | Web app | Product home, docs hub, roles, use cases, catalog, book landings, chapter reader, MD/PDF downloads — `@x12i/docify-web` |\n| **AI agents** | Markdown + packages | Per-book MD, use-case packs, chapter indexes, `agent-manifest.json`, `@x12i/docify-sdk` / product `@…-docs` |\n\nKnowledge SDKs are **devDependencies** — documentation for tools and agents, not a production runtime.\n\n---\n\n## From: Platform Overview — 1. What x12i-docify is\n\n### The problem it solves\n\nEvery product monorepo needs:\n\n- a branded docs **site** humans can browse,\n- **ebooks** with stable chapter structure,\n- **task-first use cases** that deep-link into chapters,\n- **agent-friendly** Markdown packs and a discoverable manifest,\n- one **visual system** so products do not invent competing UIs.\n\nDocify answers that with shared packages. Product folders supply content and brand strings only.\n\n### Who uses what\n\n| You are… | Primary surface | Install |\n|---|---|---|\n| Reader (human) | Product `dist/web` | Nothing — open the site |\n| Content author | `BOOK.md` + `site-pages` + `data/*.json` | Platform packages in the monorepo |\n| Integrator / platform engineer | `@x12i/docify-*` | Platform packages; optional product `@…-docs` as `devDependency` |\n| AI agent / tooling | MD downloads + knowledge SDK | `npm i -D @your-scope/<product>-docs` |\n\n---\n\n## From: Platform Overview — 2. Layers\n\n```mermaid\nflowchart TB\n Platform[x12i-docify platform packages]\n Product[\"<product>-docs content library\"]\n Web[dist/web for humans]\n SDK[\"@…-docs knowledge package\"]\n Product --> Platform\n Product --> Web\n Product --> SDK\n```\n\n| Layer | What it is |\n|---|---|\n| `x12i-docify` | Shared platform (theme, render, web, export, SDK, screenshots) |\n| `<product>-docs/` | Product content: books, site-pages, catalog, use cases |\n| `@x12i/<product>-docs` | Knowledge SDK + MD packs for agents (`npm i -D`) |\n\nMemorix is the large reference implementation: `memorix-docs/` → `@x12i/memorix-docs`. \n**This library** is the platform documenting itself (dogfood).\n\n---\n\n## From: Platform Overview — 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Package map | [Packages](../../01-packages/developers/BOOK.md) |\n| Wire a new library | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Human site behavior | [For Humans](../../03-for-humans/developers/BOOK.md) |\n| Agent / SDK path | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Theme contract | [Design System](../../05-design/developers/BOOK.md) |\n\n## Also see\n\n- **Platform Overview** (`00-platform-overview`) — What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1778
|
+
"use-cases/orient-docify.md": "# Orient on x12i-docify\n\n> **Use case id:** `orient-docify`\n> **Goal:** Understand the dual-audience platform and where product libraries fit.\n> **Audiences:** developers, builders\n> **Tags:** platform, start-here\n\n## Reading path\n\n1. **Platform Overview** (developers) → chapters: `the-central-idea`, `1-what-x12i-docify-is`, `2-layers`, `4-where-to-go-next`\n\n## From: Platform Overview — The central idea\n\n**x12i-docify** is the reusable **product site + docs + knowledge packs** platform for x12i monorepos.\n\n> One content library (`BOOK.md` + use cases). Two consumption surfaces. Same design system everywhere — products change naming and content only.\n\n| Audience | Best form | What we ship |\n|---|---|---|\n| **Humans** | Web app | Product home, docs hub, roles, use cases, catalog, book landings, chapter reader, MD/PDF downloads — `@x12i/docify-web` |\n| **AI agents** | Markdown + packages | Per-book MD, use-case packs, chapter indexes, `agent-manifest.json`, `@x12i/docify-sdk` / product `@…-docs` |\n\nKnowledge SDKs are **devDependencies** — documentation for tools and agents, not a production runtime.\n\n---\n\n## From: Platform Overview — 1. What x12i-docify is\n\n### The problem it solves\n\nEvery product monorepo needs:\n\n- a branded docs **site** humans can browse,\n- **ebooks** with stable chapter structure,\n- **task-first use cases** that deep-link into chapters,\n- **agent-friendly** Markdown packs and a discoverable manifest,\n- one **visual system** so products do not invent competing UIs.\n\nDocify answers that with shared packages. Product folders supply content and brand strings only.\n\n### Who uses what\n\n| You are… | Primary surface | Install |\n|---|---|---|\n| Reader (human) | Product `dist/web` | Nothing — open the site |\n| Content author | `BOOK.md` + `site-pages` + `data/*.json` | Platform packages in the monorepo |\n| Integrator / platform engineer | `@x12i/docify-*` | Platform packages; optional product `@…-docs` as `devDependency` |\n| AI agent / tooling | MD downloads + knowledge SDK | `npm i -D @your-scope/<product>-docs` |\n\n---\n\n## From: Platform Overview — 2. Layers\n\n```mermaid\nflowchart TB\n Platform[x12i-docify platform packages]\n Product[\"<product>-docs content library\"]\n Web[dist/web for humans]\n SDK[\"@…-docs knowledge package\"]\n Product --> Platform\n Product --> Web\n Product --> SDK\n```\n\n| Layer | What it is |\n|---|---|\n| `x12i-docify` | Shared platform (theme, render, web, export, SDK, screenshots) |\n| `<product>-docs/` | Product content: books, site-pages, catalog, use cases |\n| `@x12i/<product>-docs` | Knowledge SDK + MD packs for agents (`npm i -D`) |\n\nMemorix is the large reference implementation: `memorix-docs/` → `@x12i/memorix-docs`. \n**This library** is the platform documenting itself (dogfood).\n\n---\n\n## From: Platform Overview — 4. Where to go next\n\n| Goal | Book |\n|---|---|\n| Package map | [Packages](../../01-packages/developers/BOOK.md) |\n| Wire a new library | [Authoring a Library](../../02-authoring/developers/BOOK.md) |\n| Human site behavior | [For Humans](../../03-for-humans/developers/BOOK.md) |\n| Agent / SDK path | [For Agents](../../04-for-agents/developers/BOOK.md) |\n| Theme contract | [Design System](../../05-design/developers/BOOK.md) |\n\n## Also see\n\n- **Platform Overview** (`00-platform-overview`) — What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1779
|
+
"agent/use-cases/ship-agent-packs.md": "# Ship agent markdown and knowledge SDK\n\n> **Use case id:** `ship-agent-packs`\n> **Goal:** Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n> **Audiences:** developers\n> **Tags:** agents, sdk\n\n## Reading path\n\n1. **For Agents** (developers) → chapters: `1-best-form-for-agents`, `2-discovery`, `3-knowledge-sdk`, `4-install-contract`\n\n## From: For Agents — 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## From: For Agents — 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## From: For Agents — 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## From: For Agents — 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n\nStart-here version with the full why/when: [Getting Started & Tutorials — Installation for agents](../../06-getting-started-and-tutorials/developers/BOOK.md).\n\n## Also see\n\n- **For Agents** (`04-for-agents`) — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1780
|
+
"use-cases/ship-agent-packs.md": "# Ship agent markdown and knowledge SDK\n\n> **Use case id:** `ship-agent-packs`\n> **Goal:** Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\n> **Audiences:** developers\n> **Tags:** agents, sdk\n\n## Reading path\n\n1. **For Agents** (developers) → chapters: `1-best-form-for-agents`, `2-discovery`, `3-knowledge-sdk`, `4-install-contract`\n\n## From: For Agents — 1. Best form for agents\n\nAgents should use **structured Markdown** and **packages**, not the HTML reader:\n\n| Artifact | Role |\n|---|---|\n| Per-book `.md` | Full `BOOK.md` export |\n| Use-case packs | Assembled MD for a task |\n| `.chapters.json` | Chapter slug → title index |\n| `agent-manifest.json` | Discovery map of all downloads |\n| Knowledge SDK | `listUseCases`, `getUseCaseMarkdown`, `getBookMarkdown` |\n\n---\n\n## From: For Agents — 2. Discovery\n\nWithout the SDK:\n\n1. Open `/agent-manifest.json` on the deployed web app\n2. Follow `downloads/` paths for MD packs\n3. Prefer chapter indexes when slicing context\n\nWith the SDK: install the product knowledge package and call the typed helpers.\n\n---\n\n## From: For Agents — 3. Knowledge SDK\n\nPlatform factory: `@x12i/docify-sdk` → `createEbooksSdk(bundle)`.\n\nProduct packages pre-wire a bundle (catalog, use cases, site, manifest, embedded files). Example:\n\n```ts\nimport { memorixDocs } from \"@x12i/memorix-docs\";\n\nconst pack = memorixDocs.getUseCaseMarkdown(\"client-first-read-write\");\nconst book = memorixDocs.getBookMarkdown(\"02-runtime-data-client\", \"developers\");\nconst hits = memorixDocs.listUseCases({ audience: \"developers\", tag: \"http\" });\n```\n\nThis platform’s own package is `@x12i/docify` (`docify`) — the docs of docify itself.\n\n---\n\n## From: For Agents — 4. Install contract\n\nKnowledge packages document the product for tools and agents. They are **not** a production runtime dependency.\n\n```bash\nnpm i -D @x12i/docify # this platform’s docs\nnpm i -D @x12i/memorix-docs # Memorix product example\n```\n\nExport pipeline (`@x12i/docify-export`) emits MD + manifest alongside the web bundle. Stable use-case IDs keep agent prompts reproducible.\n\nStart-here version with the full why/when: [Getting Started & Tutorials — Installation for agents](../../06-getting-started-and-tutorials/developers/BOOK.md).\n\n## Also see\n\n- **For Agents** (`04-for-agents`) — MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1781
|
+
"agent/use-cases/ship-human-site.md": "# Ship the human web app\n\n> **Use case id:** `ship-human-site`\n> **Goal:** Build and serve dist/web with roles, use cases, catalog, and chapter reader.\n> **Audiences:** developers, builders\n> **Tags:** humans, web\n\n## Reading path\n\n1. **For Humans** (developers) → chapters: `1-best-form-for-humans`, `2-typical-flow`, `3-what-the-bundle-emits`\n\n## From: For Humans — 1. Best form for humans\n\nThe **web app** (`@x12i/docify-web`) is the human surface: case-file UI, role chooser, use-case routing, chapter reader, and download buttons.\n\nHumans should not be asked to scrape Markdown repos as their primary path. Deploy the static tree.\n\n---\n\n## From: For Humans — 2. Typical flow\n\n1. **Role** — pick developers / builders (or product-defined roles)\n2. **Use cases** — task-first entry; opens the right book + chapter\n3. **Catalog** — browse books by family\n4. **Reader** — chapter HTML in the shared book theme\n5. **Downloads** — MD (and PDF when built) for offline reading\n\nProduct home (`/`) and docs hub (`/docs`) are authored as site-pages with YAML front-matter.\n\n---\n\n## From: For Humans — 3. What the bundle emits\n\n| Path | Role |\n|---|---|\n| `index.html`, `docs.html`, … | Marketing / docs chrome from site-pages |\n| `books/<id>.html` | Book landings |\n| `read.html` + chapter HTML | Reader shell |\n| `catalog.json`, `use-cases.json`, `site.json` | Client data |\n| `downloads/` | MD / PDF / chapter indexes |\n| `agent-manifest.json` | Also useful for humans’ tooling links |\n\nAssemble with `buildContentBundle`, then overlay `docify-web/public` runtime assets (`app.js`, `read.html`, `agents.html`).\n\n---\n\n## Also see\n\n- **For Humans** (`03-for-humans`) — How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1782
|
+
"use-cases/ship-human-site.md": "# Ship the human web app\n\n> **Use case id:** `ship-human-site`\n> **Goal:** Build and serve dist/web with roles, use cases, catalog, and chapter reader.\n> **Audiences:** developers, builders\n> **Tags:** humans, web\n\n## Reading path\n\n1. **For Humans** (developers) → chapters: `1-best-form-for-humans`, `2-typical-flow`, `3-what-the-bundle-emits`\n\n## From: For Humans — 1. Best form for humans\n\nThe **web app** (`@x12i/docify-web`) is the human surface: case-file UI, role chooser, use-case routing, chapter reader, and download buttons.\n\nHumans should not be asked to scrape Markdown repos as their primary path. Deploy the static tree.\n\n---\n\n## From: For Humans — 2. Typical flow\n\n1. **Role** — pick developers / builders (or product-defined roles)\n2. **Use cases** — task-first entry; opens the right book + chapter\n3. **Catalog** — browse books by family\n4. **Reader** — chapter HTML in the shared book theme\n5. **Downloads** — MD (and PDF when built) for offline reading\n\nProduct home (`/`) and docs hub (`/docs`) are authored as site-pages with YAML front-matter.\n\n---\n\n## From: For Humans — 3. What the bundle emits\n\n| Path | Role |\n|---|---|\n| `index.html`, `docs.html`, … | Marketing / docs chrome from site-pages |\n| `books/<id>.html` | Book landings |\n| `read.html` + chapter HTML | Reader shell |\n| `catalog.json`, `use-cases.json`, `site.json` | Client data |\n| `downloads/` | MD / PDF / chapter indexes |\n| `agent-manifest.json` | Also useful for humans’ tooling links |\n\nAssemble with `buildContentBundle`, then overlay `docify-web/public` runtime assets (`app.js`, `read.html`, `agents.html`).\n\n---\n\n## Also see\n\n- **For Humans** (`03-for-humans`) — How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1783
|
+
"agent/use-cases/wire-product-library.md": "# Wire a product docs library\n\n> **Use case id:** `wire-product-library`\n> **Goal:** Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\n> **Audiences:** developers, builders\n> **Tags:** authoring, getting-started\n\n## Reading path\n\n1. **Authoring a Library** (developers) → chapters: `1-recipe`, `2-content-layout`, `3-data-contracts`, `4-build-pipeline`\n\n## From: Authoring a Library — 1. Recipe\n\n1. Depend on `@x12i/docify-{core,theme,render,export,sdk,web}` — do **not** fork theme or web app.\n2. Author books as `NN-slug/{audience}/BOOK.md`.\n3. Add product data:\n - `data/site.json` — `product`, `brand`, `brandAccent`, `siteUrl`, `knowledgePackage`\n - `data/catalog.json` — roles, families, books (kickers / colors / titles)\n - `data/use-cases.json` — task → book + chapter slugs\n4. Add `site-pages/*.md` with YAML front-matter (`product-home`, `docs-home`, …).\n5. Wire build scripts to import platform packages (see `memorix-docs/scripts/` or `x12i-docify/scripts/`).\n6. Publish `@your-scope/<product>-docs` as a **devDependency** knowledge SDK.\n7. Deploy `dist/web` for humans; ship MD + `agent-manifest.json` for agents.\n\n---\n\n## From: Authoring a Library — 2. Content layout\n\n```\n<product>-docs/\n data/{site,catalog,use-cases}.json\n site-pages/*.md\n NN-slug/\n developers/BOOK.md\n builders/BOOK.md # optional twin\n site-pages/landing.md\n diagrams/ … screenshots/\n packages/<product>-docs/ # published knowledge SDK\n scripts/build-bundle.mjs\n scripts/build-knowledge.mjs\n scripts/docs.mjs\n```\n\n---\n\n## From: Authoring a Library — 3. Data contracts\n\n| File | Owns |\n|---|---|\n| `site.json` | Brand chrome, accent CSS colors, nav, knowledge package name |\n| `catalog.json` | Roles (`developers` \\| `builders`), families, book metadata |\n| `use-cases.json` | Stable use-case ids + reading paths (bookId, audience, chapter slugs) |\n\nChapter slugs are produced by slugifying `##` headings in `BOOK.md`. Broken use-case paths **fail the bundle build**.\n\n---\n\n## From: Authoring a Library — 4. Build pipeline\n\nTypical scripts:\n\n| Script | Job |\n|---|---|\n| `build-bundle.mjs` | `buildContentBundle` → `dist/bundle` + assemble `dist/web` |\n| `build-knowledge.mjs` | Embed downloads + JSON into `packages/<sdk>/src/generated/bundle.ts` |\n| `docs.mjs` | Build if needed, `docify-web serve dist/web`, open browser |\n\nEnv: set `EBOOKS_PDF=0` or `DOCIFY_PDF=0` to skip PDF when `wkhtmltopdf` is unavailable.\n\n---\n\n## Also see\n\n- **Authoring a Library** (`02-authoring`) — Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1784
|
+
"use-cases/wire-product-library.md": "# Wire a product docs library\n\n> **Use case id:** `wire-product-library`\n> **Goal:** Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\n> **Audiences:** developers, builders\n> **Tags:** authoring, getting-started\n\n## Reading path\n\n1. **Authoring a Library** (developers) → chapters: `1-recipe`, `2-content-layout`, `3-data-contracts`, `4-build-pipeline`\n\n## From: Authoring a Library — 1. Recipe\n\n1. Depend on `@x12i/docify-{core,theme,render,export,sdk,web}` — do **not** fork theme or web app.\n2. Author books as `NN-slug/{audience}/BOOK.md`.\n3. Add product data:\n - `data/site.json` — `product`, `brand`, `brandAccent`, `siteUrl`, `knowledgePackage`\n - `data/catalog.json` — roles, families, books (kickers / colors / titles)\n - `data/use-cases.json` — task → book + chapter slugs\n4. Add `site-pages/*.md` with YAML front-matter (`product-home`, `docs-home`, …).\n5. Wire build scripts to import platform packages (see `memorix-docs/scripts/` or `x12i-docify/scripts/`).\n6. Publish `@your-scope/<product>-docs` as a **devDependency** knowledge SDK.\n7. Deploy `dist/web` for humans; ship MD + `agent-manifest.json` for agents.\n\n---\n\n## From: Authoring a Library — 2. Content layout\n\n```\n<product>-docs/\n data/{site,catalog,use-cases}.json\n site-pages/*.md\n NN-slug/\n developers/BOOK.md\n builders/BOOK.md # optional twin\n site-pages/landing.md\n diagrams/ … screenshots/\n packages/<product>-docs/ # published knowledge SDK\n scripts/build-bundle.mjs\n scripts/build-knowledge.mjs\n scripts/docs.mjs\n```\n\n---\n\n## From: Authoring a Library — 3. Data contracts\n\n| File | Owns |\n|---|---|\n| `site.json` | Brand chrome, accent CSS colors, nav, knowledge package name |\n| `catalog.json` | Roles (`developers` \\| `builders`), families, book metadata |\n| `use-cases.json` | Stable use-case ids + reading paths (bookId, audience, chapter slugs) |\n\nChapter slugs are produced by slugifying `##` headings in `BOOK.md`. Broken use-case paths **fail the bundle build**.\n\n---\n\n## From: Authoring a Library — 4. Build pipeline\n\nTypical scripts:\n\n| Script | Job |\n|---|---|\n| `build-bundle.mjs` | `buildContentBundle` → `dist/bundle` + assemble `dist/web` |\n| `build-knowledge.mjs` | Embed downloads + JSON into `packages/<sdk>/src/generated/bundle.ts` |\n| `docs.mjs` | Build if needed, `docify-web serve dist/web`, open browser |\n\nEnv: set `EBOOKS_PDF=0` or `DOCIFY_PDF=0` to skip PDF when `wkhtmltopdf` is unavailable.\n\n---\n\n## Also see\n\n- **Authoring a Library** (`02-authoring`) — Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\n- **Design System** (`05-design`) — Shared theme tokens and surfaces — products change naming and content only.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
1785
|
+
"catalog.json": "{\"roles\":[{\"id\":\"developers\",\"label\":\"Developers\",\"tagline\":\"Wire the platform\",\"description\":\"Engineers who depend on @x12i/docify-* packages, ship product docs libraries, and publish knowledge SDKs.\"},{\"id\":\"builders\",\"label\":\"Builders\",\"tagline\":\"Author the library\",\"description\":\"Content authors who write BOOK.md, site-pages, catalog entries, and use-case paths — without forking theme or web UI.\"}],\"families\":[{\"id\":\"docify\",\"name\":\"x12i-docify\",\"tagline\":\"Product site + docs + knowledge packs — one design system across monorepos.\",\"description\":\"Shared platform packages and this dogfooded docs library that documents them.\",\"color\":\"#16324f\"}],\"books\":[{\"id\":\"00-platform-overview\",\"familyId\":\"docify\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-00\",\"title\":\"Platform Overview\",\"subtitle\":\"Humans and agents, one library\",\"blurb\":\"What x12i-docify is, who it serves, and how product libraries plug in without forking UI.\",\"tags\":[\"platform\",\"start-here\",\"overview\"],\"color\":\"#16324f\",\"dir\":\"00-platform-overview\"},{\"id\":\"01-packages\",\"familyId\":\"docify\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-01\",\"title\":\"Packages\",\"subtitle\":\"The @x12i/docify-* map\",\"blurb\":\"Core, theme, render, export, SDK, web, and screenshots — what each package owns.\",\"tags\":[\"packages\",\"npm\",\"platform\"],\"color\":\"#1f6e5c\",\"dir\":\"01-packages\"},{\"id\":\"02-authoring\",\"familyId\":\"docify\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-02\",\"title\":\"Authoring a Library\",\"subtitle\":\"Books, data, site-pages, build\",\"blurb\":\"Recipe to ship a product docs library: BOOK.md layout, data/*.json, site-pages, and the build pipeline.\",\"tags\":[\"authoring\",\"content\",\"getting-started\"],\"color\":\"#a5710f\",\"dir\":\"02-authoring\"},{\"id\":\"03-for-humans\",\"familyId\":\"docify\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-03\",\"title\":\"For Humans\",\"subtitle\":\"The web app path\",\"blurb\":\"How people use @x12i/docify-web — roles, use cases, catalog, chapter reader, downloads.\",\"tags\":[\"humans\",\"web\",\"reader\"],\"color\":\"#b14a2c\",\"dir\":\"03-for-humans\",\"buildersPrimary\":true},{\"id\":\"04-for-agents\",\"familyId\":\"docify\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-04\",\"title\":\"For Agents\",\"subtitle\":\"Markdown + knowledge SDK\",\"blurb\":\"MD packs, chapter indexes, agent-manifest.json, and createEbooksSdk — install knowledge as a devDependency.\",\"tags\":[\"agents\",\"sdk\",\"markdown\"],\"color\":\"#5b3d8f\",\"dir\":\"04-for-agents\"},{\"id\":\"05-design\",\"familyId\":\"docify\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-05\",\"title\":\"Design System\",\"subtitle\":\"One look across monorepos\",\"blurb\":\"Shared theme tokens and surfaces — products change naming and content only.\",\"tags\":[\"design\",\"theme\",\"brand\"],\"color\":\"#16324f\",\"dir\":\"05-design\"},{\"id\":\"06-getting-started-and-tutorials\",\"familyId\":\"docify\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · DOC-06\",\"title\":\"Getting Started & Tutorials\",\"subtitle\":\"Install, run, author, publish\",\"blurb\":\"Start here — why agents install @x12i/docify as a devDependency, the authoring order, and hands-on tutorials.\",\"tags\":[\"getting-started\",\"tutorials\",\"install\",\"start-here\"],\"color\":\"#1f6e5c\",\"dir\":\"06-getting-started-and-tutorials\"}]}",
|
|
1786
|
+
"use-cases.json": "{\"useCases\":[{\"id\":\"orient-docify\",\"title\":\"Orient on x12i-docify\",\"goal\":\"Understand the dual-audience platform and where product libraries fit.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\",\"start-here\"],\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-central-idea\",\"1-what-x12i-docify-is\",\"2-layers\",\"4-where-to-go-next\"]}],\"alsoSee\":[\"00-platform-overview\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"map-packages\",\"title\":\"Map the @x12i/docify-* packages\",\"goal\":\"Know which package owns schemas, theme, render, export, SDK, web, and screenshots.\",\"audiences\":[\"developers\"],\"tags\":[\"packages\",\"npm\"],\"path\":[{\"bookId\":\"01-packages\",\"audience\":\"developers\",\"chapters\":[\"1-package-table\",\"2-dependency-shape\",\"3-publish-and-install\"]}],\"alsoSee\":[\"01-packages\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"wire-product-library\",\"title\":\"Wire a product docs library\",\"goal\":\"Add books, data/*.json, site-pages, and build scripts in another monorepo without forking theme or web.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"authoring\",\"getting-started\"],\"path\":[{\"bookId\":\"02-authoring\",\"audience\":\"developers\",\"chapters\":[\"1-recipe\",\"2-content-layout\",\"3-data-contracts\",\"4-build-pipeline\"]}],\"alsoSee\":[\"02-authoring\",\"05-design\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"ship-human-site\",\"title\":\"Ship the human web app\",\"goal\":\"Build and serve dist/web with roles, use cases, catalog, and chapter reader.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"humans\",\"web\"],\"path\":[{\"bookId\":\"03-for-humans\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-humans\",\"2-typical-flow\",\"3-what-the-bundle-emits\"]}],\"alsoSee\":[\"03-for-humans\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"ship-agent-packs\",\"title\":\"Ship agent markdown and knowledge SDK\",\"goal\":\"Export MD packs, agent-manifest.json, and a product @…-docs package for npm i -D.\",\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"sdk\"],\"path\":[{\"bookId\":\"04-for-agents\",\"audience\":\"developers\",\"chapters\":[\"1-best-form-for-agents\",\"2-discovery\",\"3-knowledge-sdk\",\"4-install-contract\"]}],\"alsoSee\":[\"04-for-agents\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"keep-one-design\",\"title\":\"Keep one design system\",\"goal\":\"Change product naming and content only — never fork theme or invent a competing palette.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"design\",\"theme\"],\"path\":[{\"bookId\":\"05-design\",\"audience\":\"builders\",\"chapters\":[\"1-principle\",\"2-identity\",\"3-surfaces\",\"4-do-not\"]}],\"alsoSee\":[\"05-design\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]}]}",
|
|
1787
|
+
"site.json": "{\"product\":\"docify\",\"brand\":\"x12i · docify\",\"brandAccent\":\"docify\",\"siteUrl\":\"https://docs.docify.x12i.com\",\"knowledgePackage\":\"@x12i/docify\",\"footer\":\"x12i-docify\",\"accent\":\"oklch(55% 0.15 260)\",\"accentAlt\":\"oklch(60% 0.15 40)\",\"productUrl\":\"https://github.com/x12i/memorix-mono-repo/tree/main/x12i-docify\",\"nav\":[{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Journey\",\"href\":\"/journey\"},{\"label\":\"Search\",\"href\":\"/search\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"}],\"footerLinks\":[{\"label\":\"Docs home\",\"href\":\"/docs\"},{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Journey\",\"href\":\"/journey\"},{\"label\":\"Search\",\"href\":\"/search\"},{\"label\":\"Explore\",\"href\":\"/explore\"},{\"label\":\"Concepts\",\"href\":\"/concepts\"},{\"label\":\"Guides\",\"href\":\"/guides\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"},{\"label\":\"Agents/SDK\",\"href\":\"/agents\"},{\"label\":\"Platform README\",\"href\":\"https://github.com/x12i/memorix-mono-repo/tree/main/x12i-docify\"}]}",
|
|
1788
|
+
"knowledge.json": "{\"concepts\":[{\"summary\":\"Docify only builds knowledge that authors declare — it never discovers product truth from source.\",\"problem\":\"Auto-scanning repositories invents incomplete or wrong documentation.\",\"why\":\"Accessibility requires intentional explanations, relationships, and confirmation boundaries.\",\"mentalModel\":\"Authors understand; Docify packages and presents.\",\"audiences\":[\"developers\",\"builders\"],\"whenItMatters\":[\"Starting a docs library\",\"Asking an agent to document a product\"],\"whenNotToUse\":[],\"prerequisites\":[],\"related\":[\"open-markdown\",\"knowledge-relationships\"],\"next\":[\"open-markdown\"],\"exampleIds\":[],\"commonMistakes\":[],\"successCriteria\":[],\"invariants\":[],\"alternatives\":[],\"tags\":[\"authoring\",\"boundary\"],\"id\":\"explicit-authoring\",\"type\":\"concept\",\"title\":\"Explicit authoring\",\"visualIds\":[],\"diagramIds\":[],\"referenceIds\":[]},{\"summary\":\"Every knowledge item ships as readable Markdown plus indexes — the SDK is optional.\",\"problem\":\"Knowledge trapped in generated JS or HTML blocks offline and agent workflows.\",\"why\":\"Agents and humans must grep, read, and pack the same facts without executing code.\",\"mentalModel\":\"INDEX.md and SEARCH.json are the door; Markdown files are the rooms.\",\"audiences\":[\"developers\"],\"whenItMatters\":[],\"whenNotToUse\":[],\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"next\":[\"guide-vs-scenario\"],\"exampleIds\":[],\"commonMistakes\":[],\"successCriteria\":[],\"invariants\":[],\"alternatives\":[],\"tags\":[\"agents\",\"packaging\"],\"id\":\"open-markdown\",\"type\":\"concept\",\"title\":\"Open Markdown baseline\",\"visualIds\":[],\"diagramIds\":[],\"referenceIds\":[]},{\"summary\":\"Guides are bounded procedures; scenarios branch on state; journeys compose an end-to-end outcome.\",\"problem\":\"Mixing learning, diagnosis, and production procedures confuses agents and operators.\",\"why\":\"Clear types keep invariants and confirmation boundaries enforceable.\",\"mentalModel\":\"Scenario chooses a guide; journey sequences several guides and decisions.\",\"audiences\":[\"developers\",\"builders\"],\"whenItMatters\":[],\"whenNotToUse\":[],\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"next\":[],\"exampleIds\":[],\"commonMistakes\":[],\"successCriteria\":[],\"invariants\":[],\"alternatives\":[],\"tags\":[\"authoring\"],\"id\":\"guide-vs-scenario\",\"type\":\"concept\",\"title\":\"Guides vs scenarios vs journeys\",\"visualIds\":[],\"diagramIds\":[],\"referenceIds\":[]}],\"guides\":[{\"summary\":\"Create a validated concept with problem, why, and mental model.\",\"why\":\"Concepts without why become unusable glossary stubs.\",\"audiences\":[\"developers\",\"builders\"],\"whenItMatters\":[],\"whenNotToUse\":[],\"prerequisites\":[],\"related\":[\"explicit-authoring\"],\"next\":[],\"exampleIds\":[],\"commonMistakes\":[],\"successCriteria\":[],\"invariants\":[\"Docify does not invent the concept from source code\"],\"alternatives\":[],\"confirmationRequired\":false,\"tags\":[\"authoring\"],\"id\":\"scaffold-concept\",\"type\":\"guide\",\"title\":\"Scaffold a concept page\",\"useWhen\":[\"Documenting a product idea that needs explanation first\"],\"doNotUseWhen\":[\"Writing a step-by-step production procedure (use a guide)\"],\"inputs\":[],\"permissions\":[],\"steps\":[{\"id\":\"scaffold\",\"title\":\"Run docify scaffold concept <id>\",\"expectedResult\":\"Markdown file under concepts/\",\"optional\":false},{\"id\":\"fill\",\"title\":\"Fill summary, problem, why, mental model\",\"expectedResult\":\"Human-understanding fields present\",\"optional\":false},{\"id\":\"validate\",\"title\":\"Run docify validate\",\"expectedResult\":\"Validation passes\",\"optional\":false}],\"verification\":[\"Concept appears in INDEX.md after build\"],\"recovery\":[],\"tutorialIds\":[],\"referenceIds\":[],\"scenarioIds\":[]}],\"scenarios\":[{\"summary\":\"Pick concept, guide, scenario, journey, tutorial, or reference from the reader goal.\",\"audiences\":[\"developers\",\"builders\"],\"whenItMatters\":[],\"whenNotToUse\":[],\"prerequisites\":[],\"related\":[],\"next\":[],\"exampleIds\":[],\"commonMistakes\":[],\"successCriteria\":[],\"invariants\":[\"Do not invent unsupported actions from a broad why statement\"],\"alternatives\":[],\"tags\":[],\"id\":\"choose-content-type\",\"type\":\"scenario\",\"title\":\"Choose the right Docify content type\",\"situation\":\"An agent is asked to document a product behavior and is unsure which file to create.\",\"preconditions\":[\"Product material is explicitly supplied\"],\"signals\":[\"Need a definition and why\",\"Need a bounded production procedure\",\"Need branching on observed state\",\"Need safe rehearsal with sample data\"],\"decisionQuestion\":\"Which Docify content type fits this goal?\",\"paths\":[{\"id\":\"concept\",\"label\":\"Author a concept\",\"when\":\"The reader needs what it is and why it exists\",\"rationale\":\"Concepts carry mental models before procedures.\",\"guideIds\":[\"scaffold-concept\"]},{\"id\":\"guide\",\"label\":\"Author a guide\",\"when\":\"The reader needs a bounded task with verification\",\"rationale\":\"Guides are normative procedures with confirmation boundaries.\",\"guideIds\":[\"scaffold-concept\"]},{\"id\":\"tutorial\",\"label\":\"Author a tutorial\",\"when\":\"The goal is learning with sample data and reset\",\"rationale\":\"Tutorials teach; production guides remain usable without them.\",\"guideIds\":[]}],\"verification\":[\"Selected type matches the FR selection table\"],\"recovery\":[],\"escalation\":\"If product truth is unclear, stop and ask the product owners — do not infer from source.\"}],\"decisions\":[],\"glossary\":[{\"id\":\"docify\",\"term\":\"Docify\",\"meaning\":\"x12i framework that turns explicitly authored product knowledge into a website and agent package.\",\"technicalName\":\"@x12i/docify\",\"aliases\":[\"x12i-docify\"],\"relatedConceptIds\":[\"explicit-authoring\"],\"firstPageId\":\"explicit-authoring\"},{\"id\":\"search-json\",\"term\":\"SEARCH.json\",\"meaning\":\"Deterministic local search index over all addressable knowledge items.\",\"aliases\":[\"search index\"],\"relatedConceptIds\":[\"open-markdown\"]}],\"visuals\":[],\"diagrams\":[{\"id\":\"docify-dual-audience\",\"type\":\"flow\",\"title\":\"One library, two consumption surfaces\",\"summary\":\"Explicitly authored content becomes a human website and an agent knowledge package.\",\"why\":\"Humans and agents share one source model without forked facts.\",\"direction\":\"left-to-right\",\"nodes\":[{\"id\":\"authors\",\"label\":\"Authors\",\"description\":\"Humans or agents write explicit knowledge\",\"conceptId\":\"explicit-authoring\"},{\"id\":\"validate\",\"label\":\"Validate\",\"description\":\"Schemas, links, a11y metadata\"},{\"id\":\"web\",\"label\":\"Website\",\"description\":\"Human consumption\"},{\"id\":\"agent\",\"label\":\"Agent package\",\"description\":\"INDEX, SEARCH, Markdown, SDK\",\"conceptId\":\"open-markdown\"}],\"edges\":[{\"from\":\"authors\",\"to\":\"validate\",\"label\":\"declare\",\"description\":\"Only declared inputs are processed\"},{\"from\":\"validate\",\"to\":\"web\",\"label\":\"render\"},{\"from\":\"validate\",\"to\":\"agent\",\"label\":\"pack\"}],\"howToRead\":\"Follow arrows from authored sources to human and agent outputs.\",\"keyTakeaways\":[\"Authors own product truth\",\"Docify never scans the product repository\",\"Open Markdown is the agent baseline\"],\"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.\",\"mermaid\":\"flowchart LR\\n authors[Authors] --> validate[Validate]\\n validate --> web[Website]\\n validate --> agent[Agent package]\\n\",\"audiences\":[\"developers\",\"builders\"],\"related\":[\"explicit-authoring\",\"open-markdown\"],\"tags\":[\"platform\"]}],\"relationships\":[{\"id\":\"explicit-to-open-md\",\"type\":\"prerequisiteOf\",\"from\":\"explicit-authoring\",\"to\":\"open-markdown\",\"label\":\"enables\",\"description\":\"Explicit authorship feeds open Markdown packaging\"},{\"id\":\"types-related\",\"type\":\"relatedTo\",\"from\":\"guide-vs-scenario\",\"to\":\"explicit-authoring\",\"description\":\"Type selection is part of the authoring method\"}],\"tutorials\":[],\"examples\":[],\"sampleData\":[],\"uiClients\":[],\"apis\":[]}"
|
|
619
1789
|
};
|
|
620
1790
|
//# sourceMappingURL=bundle.js.map
|