Documentation

Welcome to the portfolio documentation. This guide covers setup, development, architecture, and deployment.

Quick Links

Documentation Structure

Getting Started

• Installation - Set up the project
• Development - Day-to-day workflow
• Commands - Available npm scripts

Architecture

• Overview - System design
• Infrastructure - AWS resources
• OpenNext - Build configuration
• Packages - Monorepo structure

Features

• Chat System

  • Overview - How chat works
  • Architecture - Technical details
  • Agent API - Consumable API and porting guide
  • Configuration - Tuning options
  • Retention & Transcripts - Where conversations live, for how long, and how to read them back

• Blog

  • Overview - Blog system

• Projects - GitHub integration

• Site Analytics - Portfolio and standalone-site traffic dashboards

• Admin Assistant - Private, durable admin chat and approval-gated controls

• Authentication - NextAuth.js setup

Configuration

• Environment Variables - Complete reference
• Secrets Management - Handling secrets

Deployment

• Overview - Deployment strategy
• CI/CD - GitHub Actions
• Environments - Environment setup
• Apps Domain Convention - Apps + API routing and central SSO

Testing

• Overview - Testing strategy
• E2E Testing - Playwright tests

Package Documentation

Each package has its own README:

Contributing

When adding new documentation:

1. Place files in the appropriate category folder
2. Use consistent Markdown formatting
3. Include code examples where helpful
4. Link to related documentation
5. Update this index if adding new sections