TypeDialog/docs

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

Building & Distribution

3. BUILD.md - Building and packaging

   • Single-platform builds
   • Cross-compilation setup
   • Distribution package creation
   • Docker builds

4. RELEASE.md - Release workflow

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

Configuration

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

Quick Links

Installation & Setup

• System Requirements
• Installing just
• Installing Nickel CLI

Nickel Support

• Nickel Guide - Schema parsing, contracts, i18n, templates
• Nickel Examples - Complete examples

Development

• Quick Start Development
• Using just Commands
• Running Examples

Building

• Build Binaries
• Cross-Compilation
• Create Distribution Packages

Release

• Release Workflow
• GitHub Integration
• 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 - 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

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 for project structure.

---

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