Skip to content

docs(packs): Add "What's Included" manifest to pack files #261

@mellanon

Description

@mellanon

Pack files are large markdown documents (~50KB) where the actual contents (files created, hooks registered) are buried in documentation. Users can't quickly see what they're about to install.

Current Behavior

  • Pack is a large markdown file
  • Contents scattered throughout documentation
  • User doesn't know what files/hooks will be created until after installation
  • Surprise components (e.g., kai-hook-system includes observability library)

Problem

  1. User can't quickly answer "what am I about to install?"
  2. Pack descriptions are verbose, contents not summarized upfront
  3. Dependencies between components within a pack not clear
  4. User may not want all components (e.g., just hooks, not observability)

Suggested Fix

Add a "What's Included" summary near the top of each pack:

## What's Included

| Component | File | Purpose |
|-----------|------|---------|
| Session initializer | `hooks/initialize-session.ts` | Sets up session context |
| Core context loader | `hooks/load-core-context.ts` | Loads CORE skill |
| Security validator | `hooks/security-validator.ts` | Prompt injection defense |
| Observability lib | `hooks/lib/observability.ts` | Event logging |

**Files created:** 4
**Hooks registered:** 3
**Dependencies:** None

This gives users a quick overview before they commit to installation.

Environment

  • macOS
  • PAI v2 (current main branch)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions