Skip to content

Vik-Prabhu/mintlify-docs

Repository files navigation

Smart Fault Detector

Project Description

The Smart-Fault-Detector is a specialized diagnostic device engineered to detect actuator faults and failures in high-stakes systems like rockets and robotics. By monitoring the "pulse" of an actuator through electrical and mechanical sensors, it identifies anomalies before they lead to catastrophic system failure.

📘 Project Documentation & Deployment

🌐 Documentation (Mintlify)

This project uses Mintlify to host clean, modern documentation.

  • Built using MDX
  • Supports images, code blocks, and downloadable assets
  • Automatically deployed on every update

Documentation URL: https://teamrobomanipal-3a657712.mintlify.app/Introduction

To run docs locally:
npm install
mintlify dev

🚀 Backend Deployment (Render + Flask)

The backend is a Flask + Socket.IO server deployed on Render.

Why Render?

  • Free tier support
  • Simple GitHub integration
  • Works well with Flask APIs
  • Public endpoint accessible by ESP devices

Tech Stack

  • Python
  • Flask
  • Flask-SocketIO
  • Eventlet
  • Render Web Service

Deployment Flow

  1. Push code to GitHub
  2. Create a Web Service on Render
  3. Render installs dependencies from requirements.txt
  4. App runs on a public HTTPS URL

Dashboard URL: https://mintlify-docs-w26p.onrender.com


📡 ESP ↔ Server Communication

  • ESP device sends data via HTTP / Socket.IO

  • Flask server receives and processes data

  • Real-time updates supported using WebSockets

  • Designed for low-latency actuator/health monitoring


📂 Key Files

.
├── Firmware            # Contains ESP32-C3 Code
├── PCB                 # KiCAD Design Files
.
├── docs.json             # Contains structured metadata for the project 
├── package-lock.json     # Auto-generated file for mintlify
Dashboard_src
├── server.py              # Webserver UI
├── health_model.py        # Predictive Algorithm
├── requirements.txt       # Python dependencies

🛠️ requirements.txt

flask
flask-socketio
eventlet

✅ Status

  • Backend deployed on Render
  • Documentation live on Mintlify
  • ESP integration working

About

Product developed at the Hardware Hackathon 2.0 Conducted by pcbcupid, Lion Circuits and Param Foundation at Banglalore

Topics

Resources

License

Stars

Watchers

Forks

Contributors