<div align="center">
  <img src="../imgs/typedialog_logo_h_s.svg" alt="TypeDialog Logo" width="600" />
</div>

# TypeDialog Documentation

Complete documentation for using, building, and deploying TypeDialog.

## Getting Started

1. **[INSTALLATION.md](INSTALLATION.md)** - Prerequisites and setup
   - System requirements
   - Dependency installation
   - Verification

2. **[DEVELOPMENT.md](DEVELOPMENT.md)** - Local development
   - Using `just` for tasks
   - Common workflows
   - Examples and testing

## Building & Distribution

3. **[BUILD.md](BUILD.md)** - Building and packaging
   - Single-platform builds
   - Cross-compilation setup
   - Distribution package creation
   - Docker builds

4. **[RELEASE.md](RELEASE.md)** - Release workflow
   - Preparing releases
   - GitHub releases
   - Installation verification
   - CI/CD integration

## Configuration

5. **[CONFIGURATION.md](CONFIGURATION.md)** - Configuration guide
   - Backend-specific configs
   - Environment settings (dev, prod)
   - Custom configurations
   - Best practices

6. **[FIELD_TYPES.md](FIELD_TYPES.md)** - Field types reference
   - All supported field types
   - RepeatingGroup arrays
   - Conditional display
   - i18n support

## Quick Links

### Installation & Setup
- [System Requirements](INSTALLATION.md#prerequisites)
- [Installing just](INSTALLATION.md#just-command-orchestration)
- [Installing Nickel CLI](INSTALLATION.md#nickel-cli--optional)

### Nickel Support
- [Nickel Guide](NICKEL.md) - Schema parsing, contracts, i18n, templates
- [Nickel Examples](../examples/07-nickel-generation/) - Complete examples

### Development
- [Quick Start Development](DEVELOPMENT.md#quick-start)
- [Using just Commands](DEVELOPMENT.md#just-commands)
- [Running Examples](DEVELOPMENT.md#examples)

### Building
- [Build Binaries](BUILD.md#building-binaries)
- [Cross-Compilation](BUILD.md#cross-compilation)
- [Create Distribution Packages](BUILD.md#distribution-packages)

### Release
- [Release Workflow](RELEASE.md#release-workflow)
- [GitHub Integration](RELEASE.md#github-release)
- [Distribution Structure](RELEASE.md#distribution-structure)

## 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
```

## 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)

## Documentation Navigation

```
docs/
├── README.md              ← Overview (you are here)
├── INSTALLATION.md        ← Setup & requirements
├── DEVELOPMENT.md         ← Local development & `just` commands
├── BUILD.md               ← Building & distribution
├── RELEASE.md             ← Release workflow
├── CONFIGURATION.md       ← Backend configuration
└── NICKEL.md             ← Nickel schema support (NEW)
```

## 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)