SHA256
Актуализировать документацию и навигацию для агентов
This commit is contained in:
@@ -4,15 +4,9 @@
|
||||
|
||||
- Основной актуальный документ по личным сообщениям:
|
||||
- `README.md`
|
||||
- Его считать единственным источником истины по текущей реализованной логике DM.
|
||||
- Его считать оглавлением действующей документации DM. Точные правила и форматы находятся в перечисленных там профильных документах.
|
||||
|
||||
## Черновик будущих вложений
|
||||
## Сопровождение
|
||||
|
||||
- Файл `Черновик_будущих_DM_вложений.md` не является актуальной спецификацией.
|
||||
- В нём описан только ранний черновик того, как когда-то планировались:
|
||||
- формат вложений в DM;
|
||||
- внешние и внутренние поля вложения;
|
||||
- предполагаемая механика загрузки файлов.
|
||||
- Эта схема не была реализована в таком виде и может существенно измениться в будущем.
|
||||
- Любые решения по текущему коду, протоколу и UI нельзя принимать по этому черновику.
|
||||
- Если есть расхождение между `README.md` и черновиком вложений, верным всегда считается `README.md`.
|
||||
- При изменении DM обновлять затронутые документы из `README.md` в том же наборе изменений.
|
||||
- Черновики и устаревшие версии не использовать как действующую спецификацию.
|
||||
|
||||
@@ -12,13 +12,11 @@
|
||||
- `docs/Personal_Messages/Файлы_DM_v2.md` — большие chunked-вложения, голосовые и BitTorrent v2 SHA-256/Merkle metadata
|
||||
- `docs/API/18_DM_File_Storage_API.md` — HTTP-хранилище зашифрованных файлов DM на access-сервере отправителя
|
||||
|
||||
Исторический устаревший документ сохранён отдельно:
|
||||
|
||||
- `docs/Personal_Messages/Спецификация_DM_v0.5_устаревшая.md`
|
||||
Документы с версиями `v1` и `v2` описывают разные уровни: `v1` — контейнер и доставка сообщения, `v2` — формат больших файлов внутри зашифрованного содержимого DM. Реализация `v2` находится в `shine-UI/js/services/dm-file-service.js` и `dm-tech-blocks.js`.
|
||||
|
||||
Правило сопровождения:
|
||||
|
||||
- код DM и оба документа `Протокол_DM_v1.md` + `Формат_DM_v1.md` всегда должны обновляться синхронно;
|
||||
- код DM и затронутые документы из списка выше должны обновляться синхронно; если байтовый контейнер не менялся, это нужно прямо указать в описании изменения;
|
||||
- если меняется поведение DM в коде, в том же наборе изменений обновляется и эта документация.
|
||||
- локальная таблица пользователей для DM считается кэшем, а источником истины остаётся Solana PDA; если серверная логика DM меняет правила lazy-import пользователей из PDA, это тоже обязательно фиксируется в документации.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user