Skip to content

[DOC] Finish README and website positioning polish #206

Description

@dleshchev

Report incorrect documentation

Location of incorrect documentation

  • README.md
  • docs/images/logo.svg
  • mkdocs.yml
  • docs/benchmarks/benchmarks.md
  • Landing page snippets under docs/landing/

Describe the problems or issues found in the documentation

A few README and website positioning items need cleanup so the first-time reader gets a clearer picture of DAQIRI's hardware requirements, engine choices, peak-performance path, and benchmark results.

Current issues:

  • The README logo artwork has the daiquiri glass and compute/server element on different visual baselines.
  • README does not have a concise engine summary that says:
    • DPDK is the default raw Ethernet engine.
    • raw ibverbs is an opt-in engine for supported Mellanox/mlx5 NICs.
    • Linux TCP/UDP sockets are always available.
  • The README and website should distinguish Linux TCP/UDP sockets from RoCE more clearly. TCP/UDP sockets do not require an NVIDIA NIC; RoCE is configured through the socket stream model but still requires suitable RDMA / ConnectX hardware.
  • The README and website should state that peak-performance benchmarking and production datapaths should use the C++ API.
  • Benchmark numbers are not visible enough in the website landing flow.
  • The docs page is still labeled "Concepts" in navigation even though the page describes itself as the DAQIRI glossary.
  • The Benchmarking page decision-tree image is too large on first load.

Steps taken to verify documentation is incorrect

  • Checked origin/main README and docs navigation.
  • Checked current landing-page includes in docs/index.md.
  • Checked recent PR history for website/news handling.
  • Checked existing benchmark docs and open benchmark platform issues.

Suggested fix for documentation

  • Adjust docs/images/logo.svg so the daiquiri glass and compute/server element sit on the same horizontal plane.
  • Add a short README "Engines" section using conservative wording:
    • raw Ethernet defaults to dpdk;
    • raw ibverbs is opt-in for supported mlx5 hardware;
    • Linux TCP/UDP sockets are always built in;
    • RoCE uses the socket stream configuration model but requires RDMA-capable hardware.
  • Add a short C++ peak-performance note to README and the website/API entry points.
  • Add a compact benchmark teaser to the landing page with available measured numbers and links to detailed benchmark pages.
  • Rename the user-facing docs nav label from "Concepts" to "Glossary", if that is the intended terminology.
  • Reduce the default displayed size of the Benchmarking decision-tree image while preserving click-to-expand behavior.

Report needed documentation

Report needed documentation

Need clearer user-facing positioning for:

  • which DAQIRI paths require NVIDIA ConnectX/RDMA-capable NICs;
  • which paths work through ordinary Linux TCP/UDP sockets;
  • which engine is selected by default;
  • when to use the C++ API for peak performance;
  • what benchmark performance to expect on supported platforms.

Describe the documentation you'd like

Add a README and landing-page update that gives a new reader an accurate quick answer:

  • Linux TCP/UDP sockets work without an NVIDIA NIC.
  • RoCE is configured as a socket stream but still requires RDMA-capable / ConnectX hardware.
  • Kernel-bypass raw Ethernet and GPUDirect paths require supported NVIDIA NIC/GPU hardware.
  • DPDK is the default raw Ethernet engine.
  • raw ibverbs is an opt-in engine for supported mlx5 hardware.
  • Peak performance is expected from the C++ API.
  • Available benchmark results are visible from the landing page, with missing platform data clearly marked as pending rather than implied.

Steps taken to search for needed documentation

  • Reviewed README, Getting Started, Glossary/Concepts, Benchmarking, and landing-page snippets on origin/main.
  • Checked open benchmark issues for platform coverage.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions