Family Shapes Documentation

Welcome to the Family Shapes documentation. This is the central hub for all information about the Family Shapes platform, including architecture, features, development guidelines, and more.

Documentation Structure

The documentation is organized into the following sections:

Getting Started

• Setup guides
• Installation instructions
• Quick start tutorials
• Environment configuration

Architecture

• System architecture overview
• Component interactions
• Data flow diagrams
• Design patterns

Features

• Family tree visualization
• Organization management
• Donor database
• Connection management
• Contact and communication
• Donor Portal: Comprehensive donor portal documentation
• Implemented Features: Details of all implemented features

Development

• Stable guidelines and references (not WIP features)
• Database: Schema, migrations, and queries
• Project Priorities: Status and prioritization guidance
• Connections: Connection system implementation
• UI & Layout: UI components and layout algorithms
• Bug Fixes: Significant bug fixes and resolutions
• Performance Optimizations: Performance improvements

Deployment

• Environment setup
• Deployment procedures
• Monitoring and logging
• Performance optimization

API

• API endpoints
• Authentication
• Request and response formats
• Error handling

Contributing

• Contribution guidelines
• Code review process
• Pull request workflow
• Development environment setup

Work-In-Progress (WIP) Documents

• WIP docs for active projects/features live at the root of DOCS/ and are prefixed with WIP_.
• When complete, move them to DOCS/historical/ and remove the WIP_ prefix.
• Current WIP (if present):
  • 1003 Tree Builder UX/UI Plan
  • 1002 Sharing/Permissions/Privacy Audit

Additional Resources

• CHANGELOG.md: Chronological record of changes
• ROADMAP.md: Future development plans
• README.md: Project overview and quick start
• AGENTS.md: Instructions for AI assistants
• Database Migration Guide: Single source of truth for DB migrations. Always use Makefile targets (make db/diff, make db/migration) to generate names and ensure timestamped sequential order. Never hand-create or rename files.
• Historical Documentation: Historical documentation for reference

Documentation Status

This documentation is continuously evolving. If you find any issues or have suggestions for improvement, please create an issue or submit a pull request.

Documentation Conventions

• All documentation is written in Markdown
• Code examples use syntax highlighting
• Each document includes metadata with title, description, status, and last updated date
• Cross-references use relative links
• Images are stored in the docs/assets directory
• API documentation follows OpenAPI standards