# Plan: Docs Pipeline - Remaining Work

**Date:** 2026-03-26 (updated)
**Author:** cc-mini (with Parker)
**Existing plan:** `wip-ldm-os-private/ai/product/plans-prds/current/docs/2026-03-26--cc-mini--docs-pipeline.md`

## Status

| Step | What | Status |
|------|------|--------|
| 1 | Dependency map + 5 questions in dev guide | **Done** |
| 2 | Doc templates in shared/docs/ | **Done** (v0.4.57) |
| 3 | ldm install deploys personalized docs | **Done** (v0.4.57) |
| 4 | Convert settings/docs to templates | **Done** (v0.4.57) |
| 5a | Mintlify site at wip.computer/docs | **Done** (proxy configured, starter content live) |
| 5b | Replace starter content with our docs | **Not started** |
| 6 | Guard enforcement for doc dependencies | **Not started** |
| -- | Move dev guide to settings/ (#157) | **Done** |

## Step 5b: Replace Mintlify Starter Content

The `wipcomputer/wip-docs` repo has the Mintlify starter template. Replace it with our actual documentation.

### Full content inventory

Every README + TECHNICAL from every tool goes on the site.

**LDM OS (root product)**
- README.md (product pitch)
- TECHNICAL.md (architecture)
- references/PRODUCT.md, SKILLS-CATALOG.md, COMMANDS.md, INTERFACES.md

**LDM OS included features (docs/ directory)**
| Feature | README | TECHNICAL | SPEC |
|---------|--------|-----------|------|
| Bridge | Yes | Yes | - |
| Universal Installer | Yes | Yes | Yes |
| Shared Workspace | Yes | Yes | - |
| System Pulse | Yes | Yes | - |
| Recall | Yes | Yes | - |
| Total Recall | Yes | Yes | - |
| ACP (Agent Communication) | Yes | Yes | - |
| Skills catalog | Yes | - | - |

**Standalone products (separate repos)**
| Product | README | TECHNICAL | SKILL | Repo |
|---------|--------|-----------|-------|------|
| Memory Crystal | Yes | Yes | Yes | wipcomputer/memory-crystal |
| AI DevOps Toolbox | Yes | Yes | Yes | wipcomputer/wip-ai-devops-toolbox |
| 1Password | Yes | Yes | Yes | wipcomputer/wip-1password |
| Markdown Viewer | Yes | - | - | wipcomputer/wip-markdown-viewer |
| xAI Grok | Yes | - | Yes | wipcomputer/wip-xai-grok |
| X Platform | Yes | - | Yes | wipcomputer/wip-xai-x |
| Dream Weaver Protocol | Yes | - | - | wipcomputer/dream-weaver-protocol |
| Healthcheck | Yes | - | - | wipcomputer/wip-healthcheck |
| Bridge | Yes | - | - | wipcomputer/wip-bridge |

**Missing TECHNICAL.md (need to write)**
- wip-markdown-viewer
- wip-xai-grok
- wip-xai-x
- dream-weaver-protocol
- wip-healthcheck
- wip-bridge (has one in ldm-os docs/, not in standalone repo)

### What to develop

Replace `docs.json` with our navigation:
```
Tabs:
  LDM OS (the product)
    Getting Started
      - Introduction (from README.md)
      - Install (the install prompt flow)
      - Architecture (from TECHNICAL.md)
      - Commands Reference
      - Interface Detection
    Included Features
      - Bridge (README + TECHNICAL)
      - Universal Installer (README + TECHNICAL + SPEC)
      - Shared Workspace (README + TECHNICAL)
      - System Pulse (README + TECHNICAL)
      - Recall (README + TECHNICAL)
      - Total Recall (README + TECHNICAL)
      - ACP (README + TECHNICAL)
      - LUME

  Skills (the ecosystem)
    Core
      - Memory Crystal (README + TECHNICAL)
      - AI DevOps Toolbox (README + TECHNICAL)
      - Dream Weaver Protocol (README)
    Utilities
      - 1Password (README + TECHNICAL)
      - Markdown Viewer (README)
      - Healthcheck (README)
    APIs
      - xAI Grok (README)
      - X Platform (README)
    All Skills
      - Skills Catalog (full list)

  Guides (how to)
    - How Install Works
    - How Agents Work
    - How Worktrees Work
    - How Releases Work
    - How Backup Works
    - System Directories
    - What is ~/.ldm/?
    - Local-First Principle

  MCP (for AI clients)
    - Connect via wip.computer/docs/mcp
    - Available tools (auto-generated by Mintlify)
```

Replace starter .mdx files with content from:
- `~/wipcomputerinc/repos/ldm-os/wip-ldm-os-private/docs/` (per-subsystem docs)
- `~/wipcomputerinc/repos/ldm-os/wip-ldm-os-private/references/` (PRODUCT.md, SKILLS-CATALOG.md, etc.)
- `~/wipcomputerinc/repos/ldm-os/wip-ldm-os-private/README.md` (product pitch)

Update branding:
- Name: "LDM OS" not "Mint Starter Kit"
- Colors: match wip.computer theme
- Logo: WIP.computer logo
- Footer: WIP.computer socials (X, GitHub)
- Remove Mintlify default links (blog, support, dashboard)

### What docs to update

- `wipcomputer/wip-docs/docs.json` (navigation, branding, colors)
- `wipcomputer/wip-docs/*.mdx` (replace all starter pages)
- Remove starter directories: `essentials/`, `api-reference/`, `ai-tools/`
- Add our directories: `ldm-os/`, `skills/`, `guides/`, `reference/`

### What to test

- `https://wip.computer/docs/` loads with our content
- Navigation works (all links resolve)
- Search works
- Mobile responsive
- Internal links between pages work

## Step 5c: MCP Server for Docs

Mintlify auto-generates an MCP endpoint at `wip.computer/docs/mcp`. Any AI can connect and search our documentation. Once we replace the starter content, this becomes a live searchable knowledge base for LDM OS.

This solves Tier 2/3 from #219: cloud AIs without shell access can search our docs via MCP. No relay needed for docs.

**No development needed.** Mintlify provides this automatically. Just update the docs.json `name` field from "Mint Starter Kit" to "LDM OS" and the tool becomes `search_ldm_os`.

**To connect:** Any AI client that supports MCP can use `wip.computer/docs/mcp` as a server endpoint.

## Step 6: Guard Enforcement

A doc dependency guard that warns when you change code but don't update the corresponding docs.

### What to develop

**Option A: Pre-commit hook addition**
Add to `~/.ldm/hooks/pre-commit`:
- Read `~/wipcomputerinc/settings/docs/change-dependencies.json`
- Check which files are staged
- If a source file is staged but its dependent doc isn't, print a warning
- WARNING only, not blocking (blocking would be too aggressive)

**Option B: wip-release check**
Add to wip-release (core.mjs):
- Before publishing, check change-dependencies.json
- Compare files changed since last release vs dependent docs
- Print warnings for docs that should have been updated
- Like the existing "Product docs need attention" warning

Option B is better. It runs once at release time, not on every commit. And wip-release already has the "product docs need attention" pattern.

### What to develop (Option B)

In `wip-ai-devops-toolbox-private/tools/wip-release/core.mjs`:
1. Read `change-dependencies.json` from the repo (or from settings/docs/)
2. Get list of files changed since last tag: `git diff --name-only v{lastVersion}..HEAD`
3. For each changed file, check if its dependent docs were also changed
4. Print warnings: "! settings/docs/how-install-works.md may need updating (lib/deploy.mjs changed)"

### What docs to update

- `~/wipcomputerinc/repos/ldm-os/devops/wip-ai-devops-toolbox-private/DEV-GUIDE-GENERAL-PUBLIC.md` (document the guard)
- `~/wipcomputerinc/settings/docs/how-releases-work.md` (mention doc dependency check)

### What to test

- Change `lib/deploy.mjs`, run `wip-release patch`
- Should see warning about `settings/docs/how-install-works.md`
- Change `settings/docs/how-install-works.md` too, run again
- Warning should disappear
- npm link to test before publishing

## Files to modify

### Step 5b (wip-docs repo)
| File | Change |
|------|--------|
| `docs.json` | Replace with LDM OS navigation + branding |
| `*.mdx` (new) | Our actual doc content |
| `essentials/`, `api-reference/`, `ai-tools/` | Delete (starter content) |

### Step 6 (toolbox repo)
| File | Change |
|------|--------|
| `tools/wip-release/core.mjs` | Add doc dependency check |
| `DEV-GUIDE-GENERAL-PUBLIC.md` | Document the guard |

## Verification

```bash
# Step 5b:
open https://wip.computer/docs/   # our content, not starter
# Check all nav links work

# Step 6:
cd worktree && npm link
# Change lib/deploy.mjs without updating docs
wip-release patch --dry-run
# Should see: "! settings/docs/how-install-works.md may need updating"
npm unlink -g @wipcomputer/wip-ai-devops-toolbox
```
