Welcome to the Stellar Micro-Donation API documentation. This directory contains comprehensive documentation organized by category.
docs/
├── architecture/ # System architecture and design
├── security/ # Security audits and guidelines
├── features/ # Feature documentation
├── guides/ # How-to guides and tutorials
├── deployment/ # Deployment and operations
├── testing/ # Testing documentation
├── templates/ # Document templates
└── summaries/ # Project summaries and status
Location: docs/architecture/
- ARCHITECTURE.md - System architecture overview with diagrams
- API flow diagram.txt - API request/response flow
Location: docs/security/
- DONATION_FLOW_SECURITY_AUDIT.md - Comprehensive security audit (42 vulnerabilities identified)
- SECURITY_FIXES_IMPLEMENTATION_PLAN.md - Actionable fixes with code examples
- AUTHENTICATION_REQUIRED.md - Authentication requirements
- MEMO_SECURITY.md - Memo field security considerations
- ERROR_HANDLING.md - Error handling best practices
- STELLAR_ERROR_HANDLING.md - Stellar-specific error handling
- UNIFIED_ERROR_HANDLING_SUMMARY.md - Error handling summary
Location: docs/features/
- IDEMPOTENCY.md - Idempotency implementation for duplicate prevention
- ANALYTICS_FEE_FEATURE.md - Analytics fee calculation
- LOGGING_FEATURE.md - Logging system
- MEMO_FEATURE.md - Transaction memo support
- NETWORK_SWITCHING.md - Network switching (testnet/mainnet)
- RECENT_DONATIONS_ENDPOINT.md - Recent donations API
- SCHEDULER_RESILIENCE_FEATURE.md - Recurring donation scheduler
- STATS_API.md - Statistics and analytics API
- TRANSACTION_SYNC_CONSISTENCY.md - Transaction synchronization
- README_MEMO_FEATURE.md - Memo feature overview
Location: docs/guides/
- QUICK_START.md - Quick start guide
- PRE_DEPLOYMENT_CHECKLIST.md - Production deployment verification checklist
- MOCK_STELLAR_GUIDE.md - Using mock Stellar service for testing
- MEMO_QUICK_REFERENCE.md - Memo field quick reference
- Improved Readme.md - Enhanced README
Location: docs/deployment/
- MEMO_DEPLOYMENT.md - Memo feature deployment
- MIGRATION_GUIDE.md - Database migration guide
- DELIVERY_CHECKLIST.md - Pre-deployment checklist
- PUSH_INSTRUCTIONS.md - Git push instructions
- MANUAL_PUSH_STEPS.md - Manual deployment steps
- PULL_TROUBLESHOOTING.md - Git pull troubleshooting
Location: docs/testing/
- TEST_COVERAGE_REPORT.md - Test coverage report
- PERMISSIONS.md - Permission system testing
- PERMISSION_AUDIT_SUMMARY.md - Permission audit results
Location: docs/templates/
- PULL_REQUEST_TEMPLATE.md - Pull request template
Location: docs/
- VERSIONING_STRATEGY.md - SemVer rules, breaking vs. non-breaking change definitions, API URL versioning, release flow, hotfix procedure, deprecation policy, and changelog requirements
Location: docs/summaries/
- BRANCH_READY_SUMMARY.md - Branch readiness summary
- CHANGELOG_MEMO.md - Memo feature changelog
- FILES_DELIVERED.md - Delivered files list
- FINAL_STATUS.md - Final project status
- IMPLEMENTATION_SUMMARY.md - Implementation summary
- MEMO_IMPLEMENTATION_SUMMARY.md - Memo implementation summary
- Versioning Strategy — SemVer rules, breaking vs. non-breaking changes, release flow, deprecation policy
- Branch Protection & Merge Policy
- CI Pipeline
- Use UPPERCASE for main documents (e.g.,
ARCHITECTURE.md) - Use descriptive names that indicate content
- Include feature name in feature docs
- Start with overview/summary
- Include table of contents for long documents
- Use clear headings and sections
- Include code examples where applicable
- Add diagrams for complex concepts
- Update documentation with code changes
- Keep examples current
- Review and update quarterly
- Archive outdated documents
When adding new documentation:
- Choose appropriate directory
- Follow naming conventions
- Include in this index
- Add cross-references
- Update related documents
Date: February 22, 2026
Version: 1.0.0
Maintainer: Development Team
For documentation questions or suggestions:
- Create an issue in the repository
- Contact the development team
- Submit a pull request with improvements