Skip to main content

9 docs tagged with "Developer Guide"

View all tags

AI-Assisted Development Guide

Build NeoMind extensions, dashboard components, and contribute to the main project efficiently using Claude Code and AI-assisted development: project context setup, extension workflow, component workflow, prompt patterns, and real-world examples.

Contributing Guide

Contributing to the NeoMind main project: development setup, code standards (Rust clippy / frontend ESLint), commit conventions, CI pipeline, PR workflow, and testing requirements.

Dashboard Component Development

NeoMind dashboard component development guide: ZIP package structure, complete manifest.json reference, bundle.js IIFE format, component Props API, CSS variable theming, data source binding, complete Temperature Gauge example, installation and debugging.

Developer Guide Overview

NeoMind developer guide overview: start from one of four repo dimensions (device types / extensions / dashboard components / main project), with tech stack, crate layout, and entry points to deeper docs.

Device Type Development

NeoMind device type development guide: device data model, DeviceTypeTemplate, ConnectionConfig, MQTT topics and webhook data formats, auto-discovery flow, CLI device management, ESP32/Python hands-on examples.

Extension Development Hands-On

End-to-end guide for building a NeoMind extension from scratch with neomind-extension-sdk: scaffolding, Cargo.toml, Extension trait implementation, neomind_export!, cross-platform compile, .nep packaging, install & debug.

Extension SDK

neomind-extension-sdk reference: Extension trait, ExtensionMetadata, MetricDescriptor, neomind_export! FFI macro, capability declaration, ML model lifecycle (lazy-load + keep-loaded), cross-platform packaging (cdylib + panic=unwind).

Product Architecture

NeoMind technical architecture deep dive: crate layout and dependencies, main process + extension process isolation, event bus, extension FFI ABI, redb storage layer, Tokio concurrency and semaphores.

REST API Reference

NeoMind REST API reference: base URL, auth (JWT + API Key), unified response format, main endpoint groups (devices / dashboards / rules / agents / messages / extensions / data-push / LLM backends), Swagger entry, error format.