Skip to content

User Guides

Practical, task-oriented guides for using the Vertical Farm Management Platform. These guides focus on helping users accomplish specific tasks and make the most of platform features.

📚 Guide Categories

Features

Core platform features and how to use them effectively: - Farm Management - Create, organize, and manage farms and grow sites - Device Control - Monitor and control IoT devices and automation - Analytics & Reporting - Generate insights and track performance - User Management - Manage teams, permissions, and access control - Mobile Features - Use the mobile app and offline features

Integrations

Connect and configure external services: - Home Assistant Setup - IoT automation and device integration - Square Payments - Payment processing and billing - Supabase Queues - Background job processing - Notifications - Push notifications and alerts - Data Export - Export data to external systems

Troubleshooting

Solutions to common issues: - Common Issues - Frequently encountered problems and solutions - Debugging Guide - How to identify and fix issues - Performance Issues - Optimize slow performance - Connection Problems - Network and connectivity troubleshooting - Data Sync Issues - Resolve data synchronization problems

🚀 Quick Start Guides

For New Users

  1. Getting Started - First steps with the platform
  2. Create Your First Farm - Set up your initial farm
  3. Add Devices - Connect your first devices
  4. View Analytics - Understanding your data

For Farm Managers

  1. Daily Operations - Daily tasks and workflows
  2. Team Management - Managing your team
  3. Automation Setup - Automate routine tasks
  4. Performance Monitoring - Track farm performance

For Administrators

  1. System Configuration - Platform settings
  2. User Access Control - Security and permissions
  3. Integration Management - Configure external services
  4. Backup & Recovery - Data protection

📋 How to Use These Guides

Guide Structure

Each guide follows a consistent format: - Overview - What the feature does and why it's useful - Prerequisites - What you need before starting - Step-by-Step Instructions - Clear, numbered steps with screenshots - Tips & Best Practices - Expert recommendations - Common Issues - Troubleshooting specific to the feature - Related Guides - Links to relevant documentation

Finding What You Need

  • By Task: Browse the categories above to find guides for specific tasks
  • By Role: Check the Quick Start sections for role-specific guides
  • By Problem: Visit Troubleshooting for issue resolution
  • Search: Use the documentation search to find specific topics

🔄 Platform Workflow

graph LR
    A[Setup] --> B[Daily Use]
    B --> C[Monitor]
    C --> D[Optimize]
    D --> B

    style A fill:#e1f5e1
    style B fill:#c8e6c9
    style C fill:#a5d6a7
    style D fill:#81c784

Typical User Journey

  1. Initial Setup - Configure farms, add devices, set up integrations
  2. Daily Operations - Monitor conditions, control devices, track growth
  3. Data Analysis - Review reports, identify trends, make decisions
  4. Optimization - Adjust settings, improve efficiency, scale operations

📱 Mobile App Guide

The platform includes a Progressive Web App (PWA) for mobile access: - Install the app on your phone for offline access - Receive push notifications for critical alerts - Control devices remotely - View real-time data on the go

See Mobile Features Guide for detailed instructions.

🔔 Notifications & Alerts

Stay informed with real-time notifications: - Critical Alerts - Temperature extremes, equipment failures - Warnings - Approaching thresholds, maintenance due - Information - Daily summaries, harvest reminders

Configure in Notification Settings.

💡 Tips for Success

Best Practices

  1. Regular Monitoring - Check your dashboard daily
  2. Proactive Maintenance - Schedule regular equipment checks
  3. Data-Driven Decisions - Use analytics to guide operations
  4. Team Communication - Keep your team informed with shared reports
  5. Continuous Learning - Stay updated with new features and guides

Power User Features

  • Keyboard Shortcuts - Speed up navigation (press ? for help)
  • Bulk Operations - Manage multiple entities efficiently
  • Custom Reports - Create tailored analytics views
  • API Access - Integrate with your own systems

🆘 Getting Help

Support Resources

  • In-App Help - Click the help icon for contextual assistance
  • Troubleshooting Guides - Self-service problem solving
  • API Documentation - For developers and integrators
  • Community Forum - Connect with other users

Contact Support

For issues not covered in these guides: 1. Check the Troubleshooting section 2. Search existing documentation 3. Contact support with: - Description of the issue - Steps to reproduce - Screenshots if applicable - Your environment details

📝 Guide Maintenance

These guides are regularly updated to reflect: - New features and improvements - User feedback and common questions - Best practices and tips from experienced users - Platform updates and changes

Last Updated: December 2024 Version: 2.0

For technical documentation, see Developer Guides | For platform operations, see Operations Guide