Skip to content

Commit 35f2278

Browse files
dleshchevclaude
andauthored
#91 - Point README doc links at the live docs site (#92)
Replace docs/*.md links in the Documentation, Tutorials, and inline "Getting Started" callouts with their nvidia.github.io/daqiri/ counterparts so README readers land on the MkDocs Material-rendered pages (with search and nav) instead of raw markdown. CONTRIBUTING.md and LICENSE stay repo-relative since they aren't part of the docs site. Signed-off-by: Denis Leshchev <dleshchev@nvidia.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 261d62f commit 35f2278

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ DAQIRI provides direct NIC hardware access in userspace, bypassing the Linux ker
1212

1313
📖 **Live documentation: [nvidia.github.io/daqiri](https://nvidia.github.io/daqiri/)**
1414

15-
**Requires** an NVIDIA SmartNIC (ConnectX-6 Dx or later) and a GPUDirect-capable NVIDIA GPU. Tested on the NVIDIA DGX Spark, NVIDIA IGX platform, and an x86_64 RTX Pro server. See [Getting Started](docs/getting-started.md) for the full requirements list.
15+
**Requires** an NVIDIA SmartNIC (ConnectX-6 Dx or later) and a GPUDirect-capable NVIDIA GPU. Tested on the NVIDIA DGX Spark, NVIDIA IGX platform, and an x86_64 RTX Pro server. See [Getting Started](https://nvidia.github.io/daqiri/getting-started/) for the full requirements list.
1616

1717
## Features
1818

@@ -71,26 +71,26 @@ Container build:
7171
BASE_TARGET=dpdk DAQIRI_MGR="dpdk rdma" scripts/build-container.sh
7272
```
7373

74-
See [Getting Started](docs/getting-started.md) for requirements, CMake options, and
74+
See [Getting Started](https://nvidia.github.io/daqiri/getting-started/) for requirements, CMake options, and
7575
running the benchmarks.
7676

7777
## Documentation
7878

7979
Reference material for the DAQIRI codebase:
8080

81-
- [Getting Started](docs/getting-started.md) — System requirements, build/install instructions, and CMake options
82-
- [Configuration Reference](docs/configuration.md) — Full YAML config reference for all backends
83-
- [API Guide](docs/api-guide.md) — BurstParams, RX/TX workflows, buffer lifecycle, status codes
81+
- [Getting Started](https://nvidia.github.io/daqiri/getting-started/) — System requirements, build/install instructions, and CMake options
82+
- [Configuration Reference](https://nvidia.github.io/daqiri/configuration/) — Full YAML config reference for all backends
83+
- [API Guide](https://nvidia.github.io/daqiri/api-guide/) — BurstParams, RX/TX workflows, buffer lifecycle, status codes
8484
- [Contributing](CONTRIBUTING.md) — Contribution guidelines, coding standards, DCO sign-off
8585

8686
## Tutorials
8787

8888
Step-by-step walkthroughs to get hands-on:
8989

90-
- [Background](docs/tutorials/background.md) — Kernel-bypass and GPUDirect concepts
91-
- [System Configuration](docs/tutorials/system_configuration.md) — NIC drivers, link layers, GPUDirect, hugepages, CPU isolation, GPU clocks
92-
- [Benchmarking Examples](docs/tutorials/benchmarking_examples.md) — run `daqiri_bench_raw_gpudirect` with a loopback test
93-
- [Understanding the Configuration File](docs/tutorials/configuration-walkthrough.md) — annotated YAML walkthrough
90+
- [Background](https://nvidia.github.io/daqiri/tutorials/background/) — Kernel-bypass and GPUDirect concepts
91+
- [System Configuration](https://nvidia.github.io/daqiri/tutorials/system_configuration/) — NIC drivers, link layers, GPUDirect, hugepages, CPU isolation, GPU clocks
92+
- [Benchmarking Examples](https://nvidia.github.io/daqiri/tutorials/benchmarking_examples/) — run `daqiri_bench_raw_gpudirect` with a loopback test
93+
- [Understanding the Configuration File](https://nvidia.github.io/daqiri/tutorials/configuration-walkthrough/) — annotated YAML walkthrough
9494

9595
## License
9696

0 commit comments

Comments
 (0)