docs: consolidate documentation under doc

This commit is contained in:
2026-08-30 06:12:49 +03:00
parent 94fc8c5ef2
commit ab60e58318
17 changed files with 991 additions and 1748 deletions

42
doc/protocan/README.md Normal file
View File

@@ -0,0 +1,42 @@
# Документация ProtoCAN
Статус комплекта: **Draft**
Версия комплекта: **1.0**
Дата редакции: **2026-08-29**
Транспорт: **Classic CAN 2.0B, Extended ID, DLC 0…8**
Этот каталог разделяет нормативное описание протокола, загрузчик и реестр
общего адресного пространства. Большой исходный документ
[`Протокол CAN и ОАП.md`](../../Протокол%20CAN%20и%20ОАП.md) сохранён как
совместимое представление таблиц из Excel.
## Документы
| Документ | Назначение | Статус источника |
|---|---|---|
| [PROTOCOL.md](PROTOCOL.md) | 29-битный CAN ID, адресация, реестр `MsgType`, порядок байтов | нормативный |
| [BOOTLOADER.md](BOOTLOADER.md) | обновление прошивки, кадры, состояния, ошибки и A/B-слоты | нормативный draft |
| [OAP.md](OAP.md) | правила ведения общего адресного пространства | нормативный индекс |
| [../../Протокол CAN и ОАП.xlsx](../../Протокол%20CAN%20и%20ОАП.xlsx) | редактируемый реестр ОАП | источник таблиц |
| [examples/test-vectors.json](examples/test-vectors.json) | машинные эталоны CAN ID и payload | нормативные примеры |
| [CHANGELOG.md](CHANGELOG.md) | история версий документа | нормативный |
## Приоритет источников
При расхождении данных действует следующий порядок:
1. `PROTOCOL.md` — структура ProtoCAN и реестр типов сообщений.
2. `BOOTLOADER.md` — загрузочный сервис `0x9…0xD`.
3. XLSX — адреса и свойства регистров ОАП.
4. Сгенерированный [`../index.html`](../index.html) — только представление, не самостоятельный источник.
## Сборка HTML
Из корня проекта:
```powershell
./doc/build-html.bat
```
Все документы и тестовые векторы включаются в единый файл `doc/index.html`.
Скрипт не изменяет исходные Markdown/XLSX и пригоден для запуска в CI.