aca491ba42
ADDED: - encryption_bridge.rs: Service integration layer - encryption_contract_parser.rs: Nickel contract parsing - encryption_integration.rs: Integration tests (+442 lines) - docs/ENCRYPTION-*.md: Quick start, setup, architecture - examples/08-encryption: Usage examples - scripts/encryption-test-setup.sh: Provisioning MODIFIED: - helpers.rs: +570 lines utility functions - nickel/: Enhanced contract parsing & serialization - form_parser.rs: Constraint interpolation improvements - config/mod.rs: New configuration (+24 lines) - typedialog/src/main.rs: CLI updates (+83 lines) - Cargo.toml: encryption_bridge dependency - Cargo.lock, SBOMs: Updated AFFECTED BACKENDS: cli, tui, web (core-level changes)
TypeDialog Documentation
Complete documentation for using, building, and deploying TypeDialog.
Getting Started
-
INSTALLATION.md - Prerequisites and setup
- System requirements
- Dependency installation
- Verification
-
DEVELOPMENT.md - Local development
- Using
justfor tasks - Common workflows
- Examples and testing
- Using
Building & Distribution
-
BUILD.md - Building and packaging
- 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
Nickel Support
- Nickel Guide - Schema parsing, contracts, i18n, templates
- Nickel Examples - Complete examples
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:
- 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:
- 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)