fortify-schema/docs/README.md

TypeScript interface-like schema validation system that's easier to use than Zod

# Fortify Schema Documentation

Welcome to the comprehensive documentation for Fortify Schema - the TypeScript interface-like schema validation system that's easier to use than Zod.

##  Documentation Index

### Getting Started
- **[Quick Start Guide](../README.md#quick-start)** - Get up and running in 5 minutes
- **[Installation](../README.md#installation)** - How to install and set up
- **[Basic Usage](../README.md#basic-usage)** - Your first schema

### Core Concepts
- **[Interface Syntax](../README.md#interface-syntax)** - TypeScript-like schema definitions
- **[Type Inference](../README.md#type-inference)** - Perfect TypeScript integration
- **[Validation Modes](../README.md#validation-modes)** - Strict vs loose validation

### Field Types & Validation
- **[Complete Field Types Reference](./FIELD-TYPES.md)** - All available field types and constraints
- **[Quick Reference](./QUICK-REFERENCE.md)** - Cheat sheet for common patterns
- **[Pattern Validation](./FIELD-TYPES.md#pattern-validation)** - Regex patterns and custom validation

### Schema Transformation
- **[Mod Utilities](../README.md#schema-transformation-with-mod)** - Transform and combine schemas
- **[Schema Composition](../README.md#combining-schemas)** - Merge, pick, omit, extend
- **[Advanced Transformations](../README.md#complex-transformations)** - Chain multiple operations

### Advanced Features
- **[Nested Objects](../README.md#nested-objects)** - Complex object validation
- **[Array Validation](../README.md#array-types)** - Arrays with constraints
- **[Union Types](../README.md#constants-and-unions)** - Multiple allowed values
- **[Optional Fields](../README.md#optional-fields)** - Handling optional properties

### API Reference
- **[Interface Function](../README.md#interface-function)** - Main schema creation function
- **[Make Utilities](../README.md#make-utilities)** - Constants and unions
- **[Mod Utilities](../README.md#mod-utilities)** - Schema transformations
- **[Validation Methods](../README.md#validation-methods)** - parse, safeParse, etc.

### Examples & Recipes
- **[Real-World Examples](./EXAMPLES.md)** - Production-ready schemas and patterns
- **[Common Patterns](./QUICK-REFERENCE.md#common-patterns)** - Frequently used schemas
- **[Enterprise Examples](./EXAMPLES.md#enterprise-examples)** - Complex business schemas

### Comparison & Migration
- **[Migration Guide](./MIGRATION.md)** - Complete migration guide from Zod, Joi, Yup
- **[vs Zod](./MIGRATION.md#from-zod)** - Feature comparison and migration steps
- **[vs Joi](./MIGRATION.md#from-joi)** - Syntax differences and conversion
- **[vs Yup](./MIGRATION.md#from-yup)** - Migration examples

##  Quick Navigation

### By Use Case
- **API Validation** → [API Response Schema](../README.md#api-response-schema)
- **User Management** → [User Schema Examples](../README.md#user-management-system)
- **E-commerce** → [Product Schema](../README.md#e-commerce-product-schema)
- **Form Validation** → [Form Field Types](./FIELD-TYPES.md#basic-types)

### By Complexity
- **Beginner** → [Quick Start](../README.md#quick-start) → [Basic Types](./FIELD-TYPES.md#basic-types)
- **Intermediate** → [Constraints](./FIELD-TYPES.md#constraint-syntax) → [Schema Transformation](../README.md#schema-transformation-with-mod)
- **Advanced** → [Pattern Validation](./FIELD-TYPES.md#pattern-validation) → [Complex Examples](../README.md#real-world-examples)

### By Feature
- **Type Safety** → [Type Inference](../README.md#type-inference)
- **Performance** → [Bundle Size](../README.md#performance-and-bundle-size)
- **Developer Experience** → [IDE Support](../README.md#great-dx)

##  External Resources

- **[GitHub Repository](https://github.com/Nehonix-Team/fortify-schema)**
- **[NPM Package](https://www.npmjs.com/package/fortify-schema)**
- **[Issue Tracker](https://github.com/Nehonix-Team/fortify-schema/issues)**
- **[Changelog](https://github.com/Nehonix-Team/fortify-schema/releases)**

##  Need Help?

- **Questions?** Check the [FAQ section](../README.md#faq) or [open an issue](https://github.com/Nehonix-Team/fortify-schema/issues)
- **Bug Reports?** Use our [issue template](https://github.com/Nehonix-Team/fortify-schema/issues/new)
- **Feature Requests?** We'd love to hear your ideas!

##  Contributing

Want to improve the documentation? Check our [contribution guidelines](https://github.com/Nehonix-Team/fortify-schema/blob/main/CONTRIBUTING.md).

---

**Happy validating!**