@kolkrabbi/kol-workshop 0.1.0 → 0.1.1

package/README.md

@@ -4,9 +4,14 @@ The KOL **workshop / docs system**, lifted from the monorepo `apps/web` into the
 
 A handrolled documentation engine — no `remark`, no `gray-matter`, no `fuse.js` — plus (in later phases) the docs shell, search, and a tag system including a d3 tag graph. Sits above the other four UI packages and consumes them.
 
-## Status
+## What's in the box
 
-**Phase 1 — the pure engine (this release).** React-free, zero-dependency:
+Two entry points:
+
+- **`@kolkrabbi/kol-workshop/engine`** — the pure, React-free, zero-dependency core.
+- **`@kolkrabbi/kol-workshop`** — the React layer (docs viewer, shell, tag system) built on the engine.
+
+### Engine (`/engine`)
 
 | Import | What |
 | --- | --- |
@@ -16,23 +21,30 @@ A handrolled documentation engine — no `remark`, no `gray-matter`, no `fuse.js
 | `buildInventoryCounts(inv)` | status / category / content-type tallies |
 | `getTagColor`, `extractDocNumber`, `cleanTitle`, `groupDocsByMajor`, … | doc/tag helpers |
 
-```js
-import { parseDocsMarkdown, buildInventory } from '@kolkrabbi/kol-workshop/engine'
-```
+### React layer (`.`)
+
+| Import | What |
+| --- | --- |
+| `DocumentationReader` | the docs viewer — renders one doc from the inventory (article + header + frontmatter + token render) |
+| `ShellLayout`, `ShellSidebar` | the docs shell composition (adapts the DS `ShellHeader`/`ShellDrawer`/`ShellSearchOverlay`) |
+| `TagModeProvider`, `TagModeGate`, `TagModeOverlay`, `TagGraph` | the tag system, incl. the d3 tag graph |
+| `WorkshopSidebar`, `WorkshopDefaultSidebar` | example sidebar compositions to copy |
+
+The React layer imports its chrome (`Icon`/`Tag`/`CodeBlock`/`Divider`/`DocsToc` from `kol-component`, `ShellHeader` from `kol-framework`) from the DS packages — it keeps **no** local copies. Chrome CSS ships in `@kolkrabbi/kol-theme` (`kol-components-workshop.css`, already in the theme aggregate).
 
-### Content-injection seam
+## The content-injection seam
 
-The package is **Vite-agnostic** — it never globs your docs. The consumer supplies the raw-markdown module map:
+The package is **Vite-agnostic — it never globs your docs.** The consumer owns the `import.meta.glob` and injects the result as props:
 
 ```js
-const modules = import.meta.glob('/docs/**/*.md', { eager: true, query: '?raw', import: 'default' })
+import { buildInventory } from '@kolkrabbi/kol-workshop/engine'
+import { DocumentationReader, TagModeProvider } from '@kolkrabbi/kol-workshop'
+
+const modules   = import.meta.glob('/docs/**/*.md', { eager: true, query: '?raw', import: 'default' })
 const inventory = buildInventory(modules)
+// pass inventory + routes/basePath + docHref(id) + tagHref(tag) into the components
 ```
 
-## Roadmap
-
-- **Phase 2** — the shell + docs viewer + tag-mode components, KOL-conformed (Button / Icon-v1 / no text-transform), chrome CSS moved into `@kolkrabbi/kol-theme`.
-- **Phase 3** — content-injection seam extended to route + search config.
-- **Phase 4** — flip `private` off, publish, repoint the monorepo `apps/web` onto it, delete the local copies.
+So the package ships the **engine + chrome**, never the content — bring your own docs.
 
 Self-check: `node src/engine/__check.mjs`.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@kolkrabbi/kol-workshop",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
-  "description": "KOL workshop/docs system — handrolled markdown engine, search, tag system, and the docs shell. Sits above @kolkrabbi/kol-{theme,icons,component,framework}. Private until the conformance sweep (Phase 4) ships it.",
+  "description": "KOL workshop/docs system — a handrolled markdown engine, search, tag system (incl. a d3 tag graph), docs viewer, and docs shell. Sits above @kolkrabbi/kol-{theme,icons,component,framework}; content is consumer-injected (the package never globs docs).",
   "license": "MIT",
   "type": "module",
   "main": "./src/index.js",
@@ -14,9 +14,10 @@
   "dependencies": {
     "d3": "^7.9.0",
     "@kolkrabbi/kol-component": "0.7.0",
-    "@kolkrabbi/kol-framework": "0.3.2",
+    "@kolkrabbi/kol-brand": "0.1.0",
     "@kolkrabbi/kol-icons": "0.5.0",
-    "@kolkrabbi/kol-theme": "0.7.0"
+    "@kolkrabbi/kol-theme": "0.7.1",
+    "@kolkrabbi/kol-framework": "0.3.2"
   },
   "peerDependencies": {
     "react": "^18.3.0 || ^19.0.0",

package/src/shell/ShellLayout.jsx

@@ -4,6 +4,7 @@ import { Icon } from '@kolkrabbi/kol-icons'
 import { ShellHeader } from '@kolkrabbi/kol-framework'
 import ShellSidebar from './ShellSidebar.jsx'
 import { ShellDrawer, ShellSearchOverlay } from '@kolkrabbi/kol-component'
+import { Asset } from '@kolkrabbi/kol-brand/svg'
 
 // Pages can register right-rail TOC content via this context.
 // Usage: const setTocContent = useContext(ShellTocContext)
@@ -100,10 +101,16 @@ const ShellLayout = ({ routes = [], basePath = '/', brandLogoSrc, brandLogoAlt =
     }
   }
   const brand = (
-    <Link to={basePath} className="shell-header-logo flex items-center gap-2">
-      {brandLogoSrc
-        ? <img src={brandLogoSrc} alt={brandLogoAlt} className="h-6 w-auto" />
-        : <span className="kol-helper-12 text-emphasis">{brandLogoAlt || 'Workshop'}</span>}
+    <Link to={basePath} className="shell-header-logo flex items-center gap-2 text-emphasis">
+      {brandLogoSrc ? (
+        <img src={brandLogoSrc} alt={brandLogoAlt} className="h-6 w-auto" />
+      ) : (
+        <>
+          <Asset name="kol-wordmark" title="Kolkrabbi" className="inline-flex [&>svg]:h-5 [&>svg]:w-auto" />
+          <span className="text-fg-24" aria-hidden="true">/</span>
+          <Asset name="wordmark-workshop" title="Workshop" className="inline-flex [&>svg]:h-4 [&>svg]:w-auto" />
+        </>
+      )}
     </Link>
   )
   const searchTrigger = (