Add Docsify docs server with nginx
Move docs into docs/ directory, add Docsify for markdown rendering. Standalone Docker stack (nginx:alpine) on port 8090. wiring.html served as native HTML with correct MIME type. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
41
README.md
41
README.md
@@ -2,32 +2,30 @@
|
||||
|
||||
Уличный тренажёр с электронным управлением нагрузкой. Мотор-колесо Xiaomi M365 Pro работает как управляемый тормоз/генератор через барабан кабестана. Нагрузка регулируется током VESC-контроллера (FOC).
|
||||
|
||||
## Архитектура
|
||||
|
||||
3 узла на CAN Bus (250 Кбит/с):
|
||||
|
||||
| Узел | Компонент | Роль |
|
||||
|------|-----------|------|
|
||||
| ID:20 | Waveshare ESP32-S3 LCD 3.5" | Мастер, UI, управление |
|
||||
| ID:10 | Flipsky 75100 Pro V2 | VESC, FOC current control |
|
||||
| ID:30 | STM32F103 Blue Pill | Каретка: IMU + тензодатчик |
|
||||
|
||||
## Структура проекта
|
||||
|
||||
```
|
||||
smart-trainer/
|
||||
├── README.md # Этот файл
|
||||
├── SPEC.md # Полная инженерная спецификация
|
||||
├── CHANGELOG.md # История проектных решений v1→v4
|
||||
├── docs/
|
||||
│ └── wiring.html # Схема подключения (интерактивная)
|
||||
├── firmware/ # (будущее) прошивки ESP32, STM32
|
||||
└── cad/ # (будущее) чертежи барабана, каретки, рамы
|
||||
├── README.md
|
||||
├── docker-compose.yml # Docsify docs server
|
||||
├── docs/ # Документация (Docsify)
|
||||
│ ├── index.html # Docsify loader
|
||||
│ ├── README.md # Главная страница
|
||||
│ ├── spec.md # Инженерная спецификация
|
||||
│ ├── changelog.md # История решений v1→v4
|
||||
│ └── wiring.html # Схема подключения (интерактивная)
|
||||
├── firmware/ # (будущее) прошивки ESP32, STM32
|
||||
└── cad/ # (будущее) чертежи
|
||||
```
|
||||
|
||||
## Схема подключения
|
||||
## Документация
|
||||
|
||||
Интерактивная схема: [`docs/wiring.html`](docs/wiring.html)
|
||||
Docs server (Docsify + nginx):
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
# http://192.168.50.212:8090/
|
||||
```
|
||||
|
||||
## Как работать со схемой (wiring.html)
|
||||
|
||||
@@ -59,8 +57,3 @@ smart-trainer/
|
||||
- `mod-safety-summary` — сводка безопасности
|
||||
- `mod-bom-electronics` — BOM электроника
|
||||
- `mod-bom-power-mech` — BOM силовая + механика
|
||||
|
||||
## Документация
|
||||
|
||||
- [Спецификация](SPEC.md) — все инженерные решения и расчёты
|
||||
- [История изменений](CHANGELOG.md) — эволюция проекта v1→v4
|
||||
|
||||
Reference in New Issue
Block a user