installation.md - Prerequisites and setup
- System requirements
- Dependency installation
- Verification
development.md - Local development
- Using just for tasks
- Common workflows
- Examples and testing
pre-commit-setup.md - Automated linting hooks
- Pre-commit hook installation
- Automatic code quality checks
- Hook configuration and usage

Building & Distribution

build.md - Building and packaging
- Critical dependencies (prov-ecosystem, secretumvault, just, Nickel)
- Single-platform builds
- Cross-compilation setup
- Distribution package creation
- Docker builds
release.md - Release workflow
- Preparing releases
- GitHub releases
- Installation verification
- CI/CD integration

Configuration

configuration.md - Configuration guide
- Backend-specific configs
- Environment settings (dev, prod)
- Custom configurations
- Best practices
field_types.md - Field types reference
- All supported field types
- RepeatingGroup arrays
- Conditional display
- i18n support

Quick Links

Installation & Setup

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

Building

Release

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

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

Examples

Complete working examples are in the examples/ directory:

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

Main Resources

README.md - Project overview and features
Cargo.toml - Project manifest

Common Tasks

I want to

...get started quickly → Read installation.md, then development.md

...build from source → Read build.md

...release a new version → Read release.md

...configure backends → Read configuration.md

...set up development environment → Read development.md

...cross-compile for other platforms → Read build.md

Complete Documentation Structure

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

Documentation Structure

This documentation follows a layered approach:

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

See Architecture for project structure.

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

README.md

TypeDialog Documentation

Getting Started