文档 / 开始使用
文档概览
芳莲守护助手文档中心导读:四端协同全景、文档地图,以及如何编辑这份文档。
芳莲守护助手是一套面向独居老人家庭的轻量守护系统:ESP32 Hub 连接磁吸、压力与按钮传感器,将日常动静汇入云端,化作微信小程序里一条条安静的报平安。本管理台用于照看这片水域——设备、事件、用户与绑定关系,皆可观其流转。
系统一页速览
整套系统由四端协同构成,任一端的细节都能在本文档中心找到对应篇章。
| 端 | 技术栈 | 代码目录 | 职责 |
|---|---|---|---|
| ESP32 Hub | Arduino / PlatformIO | firmware/esp32 |
采集传感器事件,心跳与事件上报 |
| 云端后端 | Next.js API + TDengine | backend |
设备认证、事件入库、用户与订阅 |
| 微信小程序 | Taro + React | miniprogram |
用户体验入口:绑定、查看、收通知 |
| Web 管理台 | Next.js + Tailwind | web |
运营视角:设备、事件、用户、关系图谱 |
文档地图
- 开始使用
- 新用户上手指南:从领取激活码、小程序激活,到蓝牙配网、配对码绑定设备的完整步骤。
- 平台设计
- 使用手册
- Web 管理台页面说明:管理台每个页面的作用、数据来源与交互。
如何编辑这份文档
文档内容全部来自仓库中的 Markdown 文件,改文件即改文档,无需触碰页面代码:
web/content/docs/
├── overview.md ← 本篇
├── onboarding.md ← 新用户上手指南
├── architecture.md ← 顶层设计与技术架构
├── firmware.md ← 固件与烧录
└── web-pages.md ← Web 管理台页面说明
每篇文档顶部有一段 frontmatter,控制侧边栏中的标题、分组与排序:
---
title: 文档概览 # 侧边栏与正文标题
group: 开始使用 # 侧边栏分组(开始使用 / 平台设计 / 使用手册)
order: 1 # 组内排序,数字小的在前
description: 一句话摘要 # 显示在正文标题下方
---
常用约定:
- 新增一篇文档:在
web/content/docs/下新建.md文件并填好 frontmatter,侧边栏会自动出现。 - 文档之间互相链接:
[新用户上手指南](./onboarding)(./加另一篇的文件名)。 - 正文的二级(
##)、三级(###)标题会自动生成右侧「本页目录」。 - 修改后按常规流程在服务器上重新构建 Web 端即可生效。