TypeDialog/docs/README.md
Jesús Pérez 6d045d62c9
feat(repeating-groups): implement duplicate detection across all backends
- Fix has_unique flag reading from field definition (was scanning fragment fields)
- Implement duplicate validation in CLI and TUI backends
- Add item counter update in Web backend after add/delete operations
- Refactor Web JavaScript: remove global constants, use closure-based state per group
- Store repeating group config in data-* attributes instead of global variables
- Update documentation and examples with unique = true attribute
- All backends now enforce unique items validation consistently
2025-12-21 11:38:14 +00:00

4.3 KiB

TypeDialog Logo

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

  1. BUILD.md - Building and packaging

    • 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

Installation & Setup

Nickel Support

Development

Building

Release

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:

Main Resources

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)