TypeDialog/docs/README.md

TypeDialog Documentation

Complete documentation for using, building, and deploying TypeDialog.

Getting Started

1. installation.md - Prerequisites and setup

   • System requirements
   • Dependency installation
   • Verification

2. development.md - Local development

   • Using just for tasks
   • Common workflows
   • Examples and testing

3. pre-commit-setup.md - Automated linting hooks

   • Pre-commit hook installation
   • Automatic code quality checks
   • Hook configuration and usage

Building & Distribution

1. build.md - Building and packaging

   • Critical dependencies (prov-ecosystem, secretumvault, just, Nickel)
   • Single-platform builds
   • Cross-compilation setup
   • Distribution package creation
   • Docker builds

2. release.md - Release workflow

   • Preparing releases
   • GitHub releases
   • Installation verification
   • CI/CD integration

Configuration

1. configuration.md - Configuration guide

   • Backend-specific configs
   • Environment settings (dev, prod)
   • Custom configurations
   • Best practices

2. field_types.md - Field types reference

   • All supported field types
   • RepeatingGroup arrays
   • Conditional display
   • i18n support

Quick Links

Installation & Setup

• System Requirements
• Installing just
• Installing Nickel CLI

Backend-Specific Guides

• CLI Backend - Command-line prompts and scripting
• TUI Backend - Terminal UI with keyboard/mouse support
• Web Backend - HTTP server and browser forms
• AI Backend - RAG system and semantic search
• Agent System - Multi-provider LLM execution

Feature Guides

• Nickel Integration - Schema parsing, contracts, i18n, templates
• Encryption - Secure field handling
• Provisioning Generator - Infrastructure as Code generation
• Nickel Examples - Complete examples

Development

• Quick Start Development
• Using just Commands
• Running Examples

Building

• Critical Dependencies
• Build Binaries
• Cross-Compilation
• Create Distribution Packages

Release

• Release Workflow
• GitHub Integration
• Distribution Structure

Backend Documentation

Complete documentation for each TypeDialog backend:

Backend	Path	Description
CLI	cli/	Command-line interface (inquire-based prompts)
TUI	tui/	Terminal UI (Ratatui-powered interface)
Web	web/	HTTP server (Axum-based browser forms)
AI	ai/	AI backend (RAG, embeddings, knowledge graphs)
Agent	agent/	AI agent execution (multi-provider LLM)

Feature Documentation

Documentation for TypeDialog features:

Feature	Path	Description
Encryption	encryption/	Field encryption and secure data handling
Provisioning	prov-gen/	Infrastructure as Code generation

Navigation

docs/
├── README.md                 ← You are here
├── installation.md           ← Prerequisites & setup
├── development.md            ← Local development
├── build.md                  ← Building & packaging
├── release.md                ← Release workflow
├── configuration.md          ← Configuration guide
├── field_types.md            ← Field types reference
├── nickel.md                 ← Nickel schema support
├── cli/                      ← CLI backend documentation
├── tui/                      ← TUI backend documentation
├── web/                      ← Web backend documentation
├── ai/                       ← AI backend documentation
├── agent/                    ← Agent system documentation
├── encryption/               ← Encryption documentation
└── prov-gen/                 ← Provisioning generator docs
```text

## Examples

Complete working examples are in the `examples/` directory:

- [examples/README.md](../examples/README.md) - Example guide
- [examples/01-basic/](../examples/01-basic/) - Getting started
- [examples/04-backends/](../examples/04-backends/) - Backend-specific
- [examples/09-templates/](../examples/09-templates/) - Production templates

## Main Resources

- [README.md](../README.md) - Project overview and features
- [Cargo.toml](../Cargo.toml) - Project manifest

## Common Tasks

### I want to

**...get started quickly**
→ Read [installation.md](installation.md), then [development.md](development.md)

**...build from source**
→ Read [build.md](build.md#building-binaries)

**...release a new version**
→ Read [release.md](release.md#release-workflow)

**...configure backends**
→ Read [configuration.md](configuration.md)

**...set up development environment**
→ Read [development.md](development.md)

**...cross-compile for other platforms**
→ Read [build.md](build.md#cross-compilation)

## Complete Documentation Structure

```text
docs/
├── README.md              ← Overview (you are here)
│
├── Getting Started
│   ├── installation.md    ← Setup & requirements
│   ├── development.md     ← Local development & `just` commands
│   └── configuration.md   ← Backend configuration
│
├── Building & Distribution
│   ├── build.md           ← Building & cross-compilation
│   └── release.md         ← Release workflow
│
├── Reference
│   ├── field_types.md     ← Field types reference
│   └── nickel.md          ← Nickel schema support
│
├── Backends
│   ├── cli/               ← CLI backend
│   ├── tui/               ← TUI backend
│   ├── web/               ← Web backend
│   ├── ai/                ← AI backend
│   └── agent/             ← Agent system
│
└── Features
    ├── encryption/        ← Encryption & security
    └── prov-gen/          ← Infrastructure provisioning
```text

## Documentation Structure

This documentation follows a **layered approach**:

1. **Session Layer** (`.coder/`) - Interaction files (plans, summaries)
2. **Operational Layer** (`.claude/`) - Claude Code configuration
3. **Product Layer** (`docs/`) - User-facing documentation

See [Architecture](../README.md#architecture) for project structure.

---

**Latest Update**: December 2024
**Status**: Complete (+ Nickel support)