docs(readme): conventional section order, nav buttons, compact TOC
This commit is contained in:
parent
918e561a61
commit
246d42ddfa
2 changed files with 85 additions and 59 deletions
9
TODO.md
9
TODO.md
|
|
@ -152,10 +152,11 @@ guard/
|
|||
- [x] `docs/README.md` — единый индекс документации (начало работы, how-to, reference,
|
||||
протоколы, теория/research) + правила ведения: русский язык, один документ = одна
|
||||
задача, reference правится в том же PR, что и код, плоская структура, kebab-case.
|
||||
- [x] `README.md` — двуязычный: русская часть сверху, английская снизу, общий шапка/бейджи/
|
||||
переключатель языка; структура по практике (что это → как работает → возможности →
|
||||
требования → quick start → конфиг → плагины → производительность → документация →
|
||||
разработка → лицензия); TOC, копируемые команды, ссылки на docs/README.md.
|
||||
- [x] `README.md` — двуязычный: русская часть сверху, английская снизу, общая шапка/бейджи/
|
||||
переключатель языка, ряд кнопок-навигации (docs, quick start, config, API, license);
|
||||
секции по конвенции (обзор → возможности → требования → установка → быстрый старт →
|
||||
конфигурация → плагины → производительность → документация → разработка → лицензия),
|
||||
компактный TOC строкой, копируемые команды, ссылки на docs/README.md.
|
||||
- [x] `docs/configuration.md` — полная таблица `[xdp]` (включая `udp_policy`) и покрытие IPv4/IPv6;
|
||||
`docs/testing.md` — реальные XDP-smoke'и, а не только clang-проверка.
|
||||
- [x] TUI (ratatui): live-метрики из Prometheus endpoint — готово (src/tui/, 564613b).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue