documentation

Ajo Documentation

Welcome to the Ajo platform documentation. This directory contains all technical documentation, guides, and implementation details.

📚 Documentation Structure

🏗️ Architecture (architecture/)

System design, data models, and architectural decisions.

• Architecture Overview - High-level system architecture
• Profile Architecture - User profile system design
• Monitoring - System monitoring and observability
• Storage Layout - Data storage architecture
• Threat Model - Security threat analysis

📖 Guides (guides/)

Step-by-step guides and quick references organized by topic.

General Guides

• Monorepo Guide - Working with the monorepo
• Next.js Migration - Migration from Vite to Next.js
• Quick Reference Guide - Quick command reference
• Wallet Integration - Integrating Stellar wallets
• Frontend Setup - Frontend development setup
• Group Status Feature - Group status functionality
• Cycle Timing Guide - Understanding cycle timing
• Event Schema Reference - Event data schemas

Accessibility (guides/accessibility/)

• Accessibility Quick Reference
• Accessibility Testing Guide
• Accessibility Improvements

Caching (guides/caching/)

• Caching Quick Reference
• Caching Implementation
• Caching Deployment Guide
• Caching Final Report

CI/CD (guides/ci-cd/)

• CI/CD Checks
• CI/CD Enhancement Summary
• CI/CD Setup
• Create PR Instructions

Profile (guides/profile/)

• Profile Quick Start
• Profile Feature

🔧 Implementation (implementation/)

Implementation details, summaries, and technical specifications.

General Implementation

• Implementation Summary
• Design System Implementation
• Migration Summary
• Final Summary
• Cleanup Summary

Events (implementation/events/)

• Event Emission Implementation
• Event Implementation Summary

Error Handling (implementation/errors/)

• Error Handling Implementation
• Error Empty States Delivery

Validation (implementation/validation/)

• Validation Errors Implementation
• Validation Errors Summary

Icons (implementation/icons/)

• Icon Implementation Checklist
• Icon Delivery Summary

Wallet (implementation/wallet/)

• Wallet Implementation Summary

Webhooks

• Webhook Implementation Summary
• Webhook System

Profile

• Profile Implementation Summary

Environment

• Environment Implementation Summary

Copy

• Copy Implementation Guide
• In-App Copy Summary

Cycle Timing

• Cycle Timing Implementation

💻 Development (development/)

Development workflows, refactoring plans, and testing guides.

• Refactoring Plan - Comprehensive codebase refactoring plan
• Refactoring Summary - Summary of completed refactoring
• Code Quality Review - Code quality standards
• Environment Setup - Development environment setup
• Environment Quick Reference - Environment variables reference

🎨 Design (design/)

Design specifications, UI patterns, and style guides.

UI States (design/ui-states/)

• Error states, empty states, loading states, and other UI state designs

Icons (design/icons/)

• Icon system documentation and guidelines

Copy (design/copy/)

• In-app copy guidelines and tone of voice

🔌 API (api/)

API documentation and specifications.

• Backend API documentation is available at /api-docs when running the backend server
• See Backend README for API endpoint details

📋 General Documentation

• Code of Conduct - Community guidelines
• Roadmap - Project roadmap and future plans

🚀 Quick Links

Getting Started

1. Main README - Project overview and setup
2. Contributing Guidelines - How to contribute
3. Frontend README - Frontend setup
4. Backend README - Backend setup

For Developers

• Architecture Overview - Understand the system
• Refactoring Plan - Code quality improvements
• CI/CD Checks - Automated checks and workflows

For Users

• Profile Feature - User profile functionality
• Profile Quick Start - Get started with profiles

📝 Documentation Standards

When adding new documentation:

1. Location: Place docs in the appropriate subfolder

   • architecture/ - System design and architecture
   • guides/ - How-to guides and quick references
   • implementation/ - Implementation details and specs
   • development/ - Development workflows and tools
   • api/ - API documentation

2. Format: Use Markdown (.md) format

3. Naming: Use descriptive names with UPPERCASE for important docs

   • Good: CACHING_IMPLEMENTATION.md
   • Good: profile-feature.md
   • Avoid: doc1.md, temp.md

4. Content: Include

   • Clear title and description
   • Table of contents for long docs
   • Code examples where applicable
   • Links to related documentation
   • Last updated date

5. Update Index: Add new docs to this README

🔄 Maintenance

This documentation is actively maintained. If you find:

• Outdated information
• Broken links
• Missing documentation
• Unclear explanations

Please open an issue or submit a pull request.

📧 Support

For questions about the documentation:

1. Check existing docs first
2. Search closed issues
3. Open a new issue with the documentation label

---

Last Updated: February 2026