Shared Documentation

This directory contains documentation shared across multiple audience categories.

Directory Structure

Subdirectory	Content	Related Audiences
architecture/	System architecture, core integrations	backend, frontend, agent
guides/	Development philosophy guides	backend, frontend, agent
data-models/	Data model definitions	backend, frontend

Core Documentation

Document	Description	Related Audiences
Provider System	Provider system design	frontend, backend
Plugin Architecture	Plugin architecture design	backend, agent

Coding Conventions

Convention	Description
API Naming	All Gateway API query parameters and file storage use snake_case
Import Style	Use explicit import type { ... } from "..." at file top; never inline import("path").Type
Build	Never run pnpm build or pnpm typecheck from root; always cd to specific package
YAML Config	Configuration uses file-native YAML paradigm, stored in ~/.viben/
Module Child Loggers	Every module creates a Pino child logger with { module: "name" }

Usage Guide

• Frontend developers refer to architecture/ and data-models/
• Backend developers refer to architecture/ and data-models/
• Agent developers refer to architecture/ and guides/
• CLI documentation has been moved to the standalone CLI category

How to Reference from Categories

Add reference links to shared/ in each category's index.md:

## Related Shared Documentation

- [Architecture Overview](../shared/architecture/overview.md)
- [Data Models](../shared/data-models/)