@x12i/docify-docs 1.0.0 → 1.1.1

package/README.md

@@ -1,19 +1,9 @@
-# `@x12i/docify-docs`
+# @x12i/docify-docs
 
-Knowledge SDK for the **x12i-docify** platform docs library. Install as a **devDependency** only.
+Dogfood knowledge package for the Docify platform (FR rename of the former `@x12i/docify` knowledge-only role).
 
 ```bash
 npm i -D @x12i/docify-docs
 ```
 
-```ts
-import { docifyDocs } from "@x12i/docify-docs";
-
-docifyDocs.listUseCases();
-docifyDocs.getUseCaseMarkdown("orient-docify");
-docifyDocs.getBookMarkdown("00-platform-overview", "developers");
-```
-
-CLI: `docify-docs list-books` · `docify-docs use-case <id>` · `docify-docs book <id> <audience>`
-
-Content and site live in the `x12i-docify/` tree (dogfood). Humans: `npm run docs` from that folder.
+Open Markdown lives under `files/` (`INDEX.md`, `SEARCH.json`, packs). The SDK is optional.

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-import { type EbooksSdk } from "@x12i/docify-sdk";
-import { catalog, useCases, site, manifest, files } from "./generated/bundle.js";
-/** Pre-wired x12i-docify knowledge SDK. Install as a **devDependency** only. */
-export declare const docifyDocs: EbooksSdk;
-export { catalog, useCases, site, manifest, files };
-export default docifyDocs;
+/** Docify dogfood knowledge package (FR target name for platform docs). */
+export { docify as docifyDocs, docify as default, catalog, useCases, site, manifest, files, knowledge, search, createDocifySdk, } from "@x12i/docify";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEjF,gFAAgF;AAChF,eAAO,MAAM,UAAU,EAAE,SAMvB,CAAC;AAEH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACpD,eAAe,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,OAAO,EACL,MAAM,IAAI,UAAU,EACpB,MAAM,IAAI,OAAO,EACjB,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,SAAS,EACT,MAAM,EACN,eAAe,GAChB,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,13 +1,3 @@
-import { createEbooksSdk } from "@x12i/docify-sdk";
-import { catalog, useCases, site, manifest, files } from "./generated/bundle.js";
-/** Pre-wired x12i-docify knowledge SDK. Install as a **devDependency** only. */
-export const docifyDocs = createEbooksSdk({
-    catalog: catalog,
-    useCases: useCases,
-    site: site,
-    manifest: manifest,
-    files,
-});
-export { catalog, useCases, site, manifest, files };
-export default docifyDocs;
+/** Docify dogfood knowledge package (FR target name for platform docs). */
+export { docify as docifyDocs, docify as default, catalog, useCases, site, manifest, files, knowledge, search, createDocifySdk, } from "@x12i/docify";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAkB,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEjF,gFAAgF;AAChF,MAAM,CAAC,MAAM,UAAU,GAAc,eAAe,CAAC;IACnD,OAAO,EAAE,OAAc;IACvB,QAAQ,EAAE,QAAe;IACzB,IAAI,EAAE,IAAW;IACjB,QAAQ,EAAE,QAAe;IACzB,KAAK;CACN,CAAC,CAAC;AAEH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACpD,eAAe,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,OAAO,EACL,MAAM,IAAI,UAAU,EACpB,MAAM,IAAI,OAAO,EACjB,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,SAAS,EACT,MAAM,EACN,eAAe,GAChB,MAAM,cAAc,CAAC"}

package/files/INDEX.md

@@ -0,0 +1,40 @@
+# docify — knowledge index
+
+Package: `@x12i/docify`
+
+## How to choose
+
+- **Concept** — what it is and why it exists
+- **Guide** — bounded task procedure
+- **Scenario** — state + evidence → which path
+- **Use case** — end-to-end outcome
+- **Tutorial** — learn by doing
+- **Decision** — options and recommended default
+- **Reference / API** — exact technical detail
+
+## Manifest and search
+
+- `agent-manifest.json`
+- `SEARCH.json`
+
+## Concepts
+
+- `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)
+- `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)
+- `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)
+
+## Guides
+
+- `scaffold-concept` — **Scaffold a concept page** — Create a validated concept with problem, why, and mental model. — [guides/scaffold-concept.md](guides/scaffold-concept.md)
+
+## Scenarios
+
+- `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)
+
+## Diagrams
+
+- `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)
+
+## Tutorials
+
+_None authored yet._

package/files/SEARCH.json

@@ -0,0 +1,514 @@
+{
+  "version": 1,
+  "product": "docify",
+  "generatedAt": "2026-07-26T11:12:57.655Z",
+  "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": []
+    }
+  ]
+}