Welcome to BonsAI 👋 #

BonsAI is a document intelligence platform that uses AI to extract structured information from unstructured documents. This documentation will help you get started, whether you’re a new team member or an experienced developer.

🚀 Quick Start #

New to BonsAI? Start here:

1. Getting Started Guide - Set up your Coder workspace and get running in minutes
2. Development Workflow - Learn our development process and best practices
3. Example Workflow - Follow a complete end-to-end example: adding a new field to invoice extraction

Need help? Contact the team on Slack or email us at dev@gotofu.com

📚 Documentation Sections #

For New Developers #

Start with these guides to get up and running:

• Getting Started - Your first steps with BonsAI development
• Development Workflow - How we work: branches, PRs, and code quality
• Coder Setup - Understanding our cloud development environment
• Tools Guide - Cursor, Doppler, Linear, and other essential tools

Services & Architecture #

Understand the BonsAI platform:

• Webapp - Next.js frontend application (TypeScript, React, TanStack Query)
• BonsAPI - Rust backend service (Actix Web, PostgreSQL)
• Hinoki - ML-powered document processing engine (Python, RabbitMQ)
• Database - Schema, migrations, and CloudBeaver database management

Advanced Topics #

Deep dives for experienced developers:

• Preview Environments - Comprehensive guide to PR-based preview deployments
• E2E Testing - Playwright testing framework and best practices
• Infrastructure - AWS, Kubernetes, and deployment architecture
• Integrations - Third-party integrations (Intercom, Xero, QuickBooks)
• Release Management - Using Hasami for version management

Operations & Deployment #

For DevOps and production concerns:

• Infrastructure Overview - AWS architecture and cloud resources
• Kubernetes - Container orchestration and deployment
• Preview Lifecycle - Managing preview environment lifecycle
• Troubleshooting - Common issues and solutions

Operations Runbooks #

Step-by-step guides for production operations and incident response:

• Operations Runbooks - Complete collection of operational procedures
• Monitoring & Alerting - Using Datadog, Sentry, and CloudWatch
• Kubernetes Debugging - Troubleshooting pods and deployments
• Database Access - Safely accessing production databases
• Incident Response - Handling production incidents

🔍 Quick Links #

Common Tasks #

• Create a new feature
• Run tests
• Deploy a preview environment
• Test webhooks locally
• Manage database migrations
• Release with Hasami
• Respond to production incidents
• Debug Kubernetes pods
• Access production database

Tools & Services #

• Coder Workspace - Cloud development environment
• GitHub Repository - Source code
• Linear - Issue tracking
• Doppler - Secrets management
• CloudBeaver - Database management

🆘 Need Help? #

• Production incident? Follow the Incident Response runbook
• Stuck? Check the Troubleshooting Guide or Operations Runbooks
• Git issues? See Git SSH Troubleshooting
• Questions? Reach out on Slack or dev@gotofu.com

📝 Contributing to Documentation #

This documentation lives in the repository at /docs/internal. To improve it:

1. Open the file you want to edit in your Coder workspace
2. Make your changes to the Markdown files
3. Submit a pull request with your improvements

The documentation site is built with Hugo and automatically deployed when changes merge to main.

Ready to dive in? Head to the Getting Started Guide to set up your environment!