#69 - Apply docs review feedback

[chloecrozier]

Summary

Follow-up to the previous docs PR, addressing review feedback.

Content changes

• Concepts — switched from the "kernel bypass / DPDK / RDMA / Socket backend" framing to stream_type + protocol. Stream Types section now has Raw / Socket (UDP, TCP, RoCE) / PCIe (future). Added a GPUDirect mermaid diagram, rewrote Packets/Bursts/Segments/Flow/Memory Regions per the wording suggestions.
• Getting Started — relaxed NVIDIA NIC requirement to only the kernel-bypass / GPUDirect / RoCE paths. Bumped CUDA minimum from 11.7+ to 12.2+. Inlined the bare-metal apt dependency list. Recommend doca-ofed for diagnostic utilities.
• Landing page — TX-and-RX tagline, real flows: block in the Hardware Flow Steering example, sudo … --check all diagnostic command, "Raw Ethernet" instead of "DPDK" in user-facing prose.
• Spark GPUDirect tutorial — inverted to lead with "no setup required, use host_pinned", peermem/dma-buf error details moved into a collapsed admonition.
• Decision tree (configuration-walkthrough.md) — relabeled with stream_type / protocol. RDMA reframed as for third-party RoCE endpoints (FPGA, instrument); two DAQIRI peers should use MPI / NCCL / UCX.
• Sitewide DPDK → Raw Ethernet copy sweep (literal DAQIRI_MGR=dpdk, daqiri_dpdk_* etc. kept).

Layout / nav

• Promoted Benchmarks to a top-level nav entry (no file move).
• Added hover dropdowns to "API Reference" and "Tutorials" tabs (both on the landing page and on MkDocs-rendered pages) so users can hop directly to sub-pages.
• Hid the left section sidebar on multi-page section pages (API Reference, Tutorials); the dropdowns replace that navigation.
• Fixed the CMake-options table wrapping single letters (widened --md-grid to 76rem, white-space: nowrap on table <code> cells).
• Fixed navbar wrap on narrow viewports (white-space: nowrap on links/buttons, collapse breakpoint).
• Right-hand TOC has consistent spacing between items in both light and dark mode.

Test plan

• mkdocs build --strict — passes locally
• scripts/check_doc_refs.py — passes locally
• Toggle light/dark — layout/spacing matches in both
• Hover "API Reference" and "Tutorials" tabs — dropdown opens with sub-page links

[greptile-apps]

Greptile Summary

This PR applies documentation review feedback for issue #69: it replaces the "kernel bypass / DPDK / RDMA / Socket backend" user-facing framing with stream_type + protocol vocabulary, adds a hamburger drawer and section dropdowns to the landing-page nav, and promotes Benchmarks to a top-level MkDocs nav entry.

• Terminology sweep — docs/concepts.md, docs/getting-started.md, docs/api-reference/configuration.md, docs/api-reference/cpp.md, docs/tutorials/configuration-walkthrough.md, AGENTS.md, and docs/index.html all updated; docs/api-reference/python.md has one remaining "DPDK backend" phrase on line 133 that was not caught by the sweep.
• Nav / layout — landing-page hamburger drawer added for viewports <1100 px (addressing previous review feedback), tab-dropdowns.js injects hover dropdowns into MkDocs tabs, hide: navigation added to all multi-page section sub-pages; however, Python API Usage is absent from both the tab-dropdowns.js SECTIONS map and the docs/index.html API Reference dropdown, leaving it unreachable from the other three sidebar-hidden API Reference pages.
• Getting Started — CUDA minimum bumped to 12.2+, NIC requirement scoped to kernel-bypass/GPUDirect/RoCE paths, bare-metal apt dependency list inlined.

Confidence Score: 4/5

Safe to merge after fixing the Python API navigation gap; all code paths are documentation-only with no library or build changes.

The Python API Usage page is missing from both the tab-dropdowns.js SECTIONS map and the landing-page dropdown. The three other API Reference pages gained hide: navigation in this PR, so the injected dropdown is now the only way to navigate between them — and Python API isn't listed. Users who land on the C++ API or Configuration YAML Reference pages via direct link have no in-page route to the Python docs. Everything else in the PR is consistent and well-executed.

docs/javascripts/tab-dropdowns.js (missing Python API entry in SECTIONS) and docs/index.html (missing Python API

in the API Reference dropdown).

Important Files Changed

Filename	Overview
docs/javascripts/tab-dropdowns.js	New JS file that injects hover dropdowns into MkDocs tab items; API Reference section is missing Python API Usage, leaving it unreachable from sidebar-hidden pages.
docs/index.html	Landing page updated with hamburger drawer for <1100 px viewports, nav dropdowns, and Raw Ethernet/stream_type terminology sweep; Python API also missing from the landing-page API Reference dropdown.
docs/api-reference/python.md	Only the broken anchor link was fixed; the "DPDK backend" text on line 133 was not updated to match the terminology sweep applied to cpp.md.
docs/concepts.md	Replaced Kernel Bypass / backend framing with stream_type + protocol sections; added GPUDirect mermaid diagram and rewrote Packets/Bursts/Segments/Flow/Memory Regions.
docs/getting-started.md	Relaxed NIC requirement to kernel-bypass/GPUDirect/RoCE paths only, bumped CUDA minimum to 12.2+, and inlined bare-metal apt dependency list.
docs/stylesheets/extra.css	Added content-width increase, nowrap on table code cells, tab-dropdown styles, and TOC item spacing; clean universal/slate scoping.
mkdocs.yml	Promoted Benchmarks to a top-level nav entry and added tab-dropdowns.js to extra_javascript.
AGENTS.md	Updated docs structure description to reflect stream_type/protocol vocabulary and the Benchmarks promotion.
docs/tutorials/configuration-walkthrough.md	Decision tree relabeled from backend to stream_type/protocol; RoCE reframed as third-party endpoint use case; hide: navigation added.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["API Reference tab (MkDocs)"] -->|"tab-dropdowns.js injects dropdown"| D1["API Guide\n(hide: navigation ✓)"]
    A -->|"tab-dropdowns.js injects dropdown"| D2["Configuration YAML Reference\n(hide: navigation ✓)"]
    A -->|"tab-dropdowns.js injects dropdown"| D3["C++ API Usage\n(hide: navigation ✓)"]
    A -.->|"missing from dropdown"| D4["Python API Usage\n(sidebar still shown)"]
    D1 -. "No sidebar, no dropdown link" .-> D4
    D2 -. "No sidebar, no dropdown link" .-> D4
    D3 -. "No sidebar, no dropdown link" .-> D4
    style D4 stroke:#f00,stroke-width:2px

Loading

_{Reviews (3): Last reviewed commit: "#69 - Fix python.md link to RX Reorder C..." | Re-trigger Greptile}

[greptile-apps]

Nav links hidden at 1100 px with no fallback navigation

The responsive breakpoint that hides .nav-links was raised from 640 px to 1100 px. On viewports between 640 px and 1100 px (tablets, small laptops), the entire top-nav strip — Concepts, Benchmarks, API Reference dropdown, Tutorials dropdown, News — disappears, but no hamburger menu or drawer is added. The .nav-actions buttons (GitHub / Docs) remain visible, but the only way to reach the new Concepts and Benchmarks pages from the landing page at that viewport is through the hero or tutorials scroll-list, which are not always visible above the fold.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!