Иногда при написании документации не хватает визуальной составляющей, особенно когда нужно описать высокоуровневые взаимодействия компонентов системы, и прочие штуки, которые тяжело воспринимать без диаграммок.
На радость крудошлепам любителям повизуализировать, я сделяль интеграцию
mermaid.js в растовые док-комменты, чтобы можно было вообще из
docs.rs не вылезать.
Пример как это выглядит в коде:
#[aquamarine]
/// mermaid
/// graph LR
/// s([Source]) --> a[[aquamarine]]
/// r[[rustdoc]] --> f([Docs w/ Mermaid!])
/// subgraph rustc[Rust Compiler]
/// a -. inject mermaid.js .-> r
/// end
///
pub fn example() {}
Ссылки:
crates.io docs.rs github пост на r/rust (буду благодарен апвоуту :p)
#сделяль