Documentation Hub

Welcome to the Agentic Node + TypeScript Starter documentation! This template provides a batteries-included foundation for building Node.js applications with TypeScript, comprehensive testing, and quality automation.

📚 Documentation Structure

Getting Started

• GETTING_STARTED.md - Step-by-step setup guide for using this template
• TROUBLESHOOTING.md - Common setup issues and solutions

Development

• DEVELOPMENT.md - Daily development workflow and commands
• PATTERNS.md - Copy-paste code patterns and examples
• TESTING.md - Testing strategies and examples
• PROCESS.md - AI-assisted (agentic) development workflow

Reference

• CHECKLISTS.md - Quick reference checklists
• OBSERVABILITY.md - Logging and monitoring setup
• ../CLAUDE.md - AI-assisted development with Claude

Architecture Decisions

• architecture/decisions/ - All ADRs documenting key technical choices

🚀 Quick Links

First Time Setup

1. Prerequisites & Installation
2. Initial Configuration
3. Verify Everything Works

Common Tasks

• Run Tests - pnpm test
• Check Code Quality - pnpm verify
• Start Development - pnpm dev
• Create a Release - pnpm changeset

When You're Stuck

• Node/pnpm Version Issues
• TypeScript Errors
• CI/CD Failures
• Test Coverage Problems

📖 How to Use This Documentation

1. New to the template? Start with GETTING_STARTED.md
2. Ready to code? Check DEVELOPMENT.md for workflows
3. Need examples? Find copy-paste patterns in PATTERNS.md
4. Customizing? See GETTING_STARTED.md for how to adapt this template
5. Having issues? Consult TROUBLESHOOTING.md

🎯 Template Philosophy

This starter template follows these principles:

• Batteries Included - Everything you need to start building immediately
• Type Safety First - Strict TypeScript with runtime validation
• Test Everything - Unit tests, property-based tests, 80% coverage minimum
• Automate Quality - Pre-commit hooks, CI/CD, automated releases
• Security by Default - Dependency scanning, SBOM generation, attestations

📝 Contributing to Documentation

When updating documentation:

1. Keep examples practical and copy-paste ready
2. Focus on "how to use the template" not hypothetical applications
3. Update timestamps when making significant changes
4. Ensure all commands are tested and working
5. Link between related documents for easy navigation

---

Last Updated: 2025-08-30