Engineering Technical Documentation
Welcome to our Engineering technical documentation site. This comprehensive resource covers all aspects of our engineering practices, infrastructure, and project-specific information.
๐ Documentation Sectionsโ
๐๏ธ Infrastructure and DevOpsโ
Complete infrastructure setup, deployment procedures, and operational guidelines:
- AWS Infrastructure Overview - Multi-account AWS setup and access procedures
- GitLab Pipelines - CI/CD pipeline configuration and monitoring
- Local Environment Setup - Development environment configuration
๐ Security and Privacyโ
Security protocols, privacy guidelines, and access control:
- Content Access Controls - User permission and content security
- Content Encryption - Data encryption standards and practices
๐ Projectsโ
Project-specific documentation and technical details:
- Farfalla - Main platform backend and core services
- Fenice - Reader applications (mobile and desktop)
- Medusa - Content intake and processing platform
- Volpe - Content rendering engine
- Coniglio - Analytics and reporting system
- Castoro - PDF processing and optimization
๐ค AI and Automationโ
Artificial intelligence tools and automated workflows:
- AI Best Practices - Guidelines for AI and automation workflows
- AI Workflows - Automated error handling and task management
- Prompt Library - AI prompts and templates
๐ง General Engineeringโ
Development standards, processes, and best practices:
- Git Guidelines - Version control best practices
- Style Guides - Code formatting and standards
- Design Process - Development workflow and design standards
- Contributing to Docs - Documentation contribution guidelines
๐งช Quality Assuranceโ
Testing procedures, automation, and quality standards:
- Testing Overview - QA processes and methodologies
- Accessibility Testing - Web accessibility compliance
- Test Automation - Automated testing strategies
- Bug Reporting - Bug report templates and procedures
๐ External Resourcesโ
Team Methodologyโ
For information about our team methodology and workflows, refer to our Team Process Documentation.
Quick Linksโ
- GitLab Organization - Source code and CI/CD pipelines
- AWS Console - Infrastructure management
- Monitoring Dashboard - System performance and metrics
๐ How to Use This Documentationโ
For New Team Membersโ
- Start with Infrastructure Overview for AWS access
- Set up your Local Development Environment
- Review General Engineering Guidelines
- Explore project-specific documentation for your assigned projects
For Existing Team Membersโ
- Use the search functionality to find specific topics
- Check project documentation for deployment and troubleshooting guides
- Refer to AI and Automation sections for workflow optimization
- Consult QA documentation for testing procedures
Contributing to Documentationโ
- Follow the Contributing Guidelines for proper procedures
- Use consistent formatting and structure
- Include practical examples and code snippets
- Update related documentation when making changes