Platform Overview

# x12i-docify Platform Overview — Developers **Audience:** Engineers wiring `@x12i/docify-*` into a monorepo or publishing a product knowledge SDK.

  • Install (start here)
  • How to read this guide
  • The central idea
  • 1. What x12i-docify is
  • 2. Layers
  • 3. Hard rules
  • 4. Where to go next

Packages

# Packages — Developers **Audience:** Engineers choosing and wiring `@x12i/docify-*` packages.

  • 1. Package table
  • 2. Dependency shape
  • 3. Publish and install
  • 4. Migration names

Authoring a Library

# Authoring a Library — Developers **Audience:** Engineers scaffolding a product docs library on docify.

  • 1. Recipe
  • 2. Content layout
  • 3. Data contracts
  • 4. Build pipeline
  • 5. Humans vs agents after build

For Humans

# For Humans — Developers **Audience:** Engineers shipping `dist/web` for human readers.

  • 1. Best form for humans
  • 2. Typical flow
  • 3. What the bundle emits
  • 4. Product libraries

For Agents

# For Agents — Developers **Audience:** Engineers shipping agent-consumable knowledge.

  • 1. Best form for agents
  • 2. Discovery
  • 3. Knowledge SDK
  • 4. Install contract

Design System

# Design System — Developers **Audience:** Engineers integrating theme assets into a product build.

  • 1. Principle
  • 2. Identity
  • 3. Surfaces
  • 4. Do not

Getting Started & Tutorials

# Getting Started & Tutorials — Developers **Audience:** Engineers adopting docify in a monorepo — from first install to a published knowledge package.

  • 1. Installation for agents
  • 2. Getting started
  • 3. Best practice — authoring order
  • 4. Tutorial — run the docs site
  • 5. Tutorial — author a book
  • 6. Tutorial — publish the knowledge package
  • 7. Where to go next