Skip to content

[docs] Clarify HSB RFSoC artifact locations#4687

Draft
caldwellshane wants to merge 3 commits into
NVIDIA:mainfrom
caldwellshane:codex/realtime-hsb-ip-docs
Draft

[docs] Clarify HSB RFSoC artifact locations#4687
caldwellshane wants to merge 3 commits into
NVIDIA:mainfrom
caldwellshane:codex/realtime-hsb-ip-docs

Conversation

@caldwellshane

Copy link
Copy Markdown
Contributor

Summary

  • Clarify that the HSB 2.6.0-EA RFSoC collateral is split between the URM artifact directory and the Holoscan Sensor Bridge release-2.6.0-EA branch.
  • Document where to find the prebuilt nvqlink_rfsoc_v2603.bit, the pynq_rfsoc_2603_EA_release.zip reference-design archive, and the matching nv_hsb_ip source directory.
  • Add build-placement guidance for nv_hsb_ip, warn against mixing HSB release collateral, and call out the default RFSoC Vivado part target.
  • Fix stale cudaq_realtime_message_protocol.bs references to .md and clean up a few wording issues in the realtime docs.

Why

The RFSoC reference archive expects nv_hsb_ip, but that source directory is not inside the archive.
The docs previously pointed users at a single location, which made the HSB IP core hard to find and made it easy to mix artifacts from different HSB releases.

Validation

  • Ran git diff --check.
  • Reviewed the staged diff before committing.

Notes

This is a documentation-only change.

@github-actions

github-actions Bot commented Jun 6, 2026

Copy link
Copy Markdown

CI Summary (push) — ✅ passed

Run #27137708471 · ✅ 6 · ⏩ 7 · ❌ 0 · ⛔ 0

Top-level jobs (13)
Job Result
binaries ⏩ skipped
build_and_test ✅ success
config_devdeps ✅ success
config_source_build ⏩ skipped
config_wheeldeps ✅ success
devdeps ✅ success
docker_image ⏩ skipped
gen_code_coverage ⏩ skipped
metadata ✅ success
python_metapackages ⏩ skipped
python_wheels ⏩ skipped
source_build ⏩ skipped
wheeldeps ✅ success
⏩ Skipped jobs (7) — intentionally skipped on PR builds; run on merge_group / workflow_dispatch
Job
binaries
config_source_build
docker_image
gen_code_coverage
python_metapackages
python_wheels
source_build
All sub-jobs (42) — every matrix leg, with links
Job Status Link
Build and test (amd64, gcc12, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Python) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view
CI Summary ❔ in_progress view
Configure build (devdeps) ✅ success view
Configure build (source_build) ⏩ skipped view
Configure build (wheeldeps) ✅ success view
Create CUDA Quantum installer ⏩ skipped view
Create Docker images ⏩ skipped view
Create Python metapackages ⏩ skipped view
Create Python wheels ⏩ skipped view
Gen code coverage ⏩ skipped view
Load dependencies (amd64, gcc12) / Caching ✅ success view
Load dependencies (amd64, gcc12) / Finalize ✅ success view
Load dependencies (amd64, gcc12) / Metadata ✅ success view
Load dependencies (amd64, llvm) / Caching ✅ success view
Load dependencies (amd64, llvm) / Finalize ✅ success view
Load dependencies (amd64, llvm) / Metadata ✅ success view
Load dependencies (arm64, gcc12) / Caching ✅ success view
Load dependencies (arm64, gcc12) / Finalize ✅ success view
Load dependencies (arm64, gcc12) / Metadata ✅ success view
Load dependencies (arm64, llvm) / Caching ✅ success view
Load dependencies (arm64, llvm) / Finalize ✅ success view
Load dependencies (arm64, llvm) / Metadata ✅ success view
Load source build cache ⏩ skipped view
Load wheel dependencies (amd64, 12.6) / Caching ✅ success view
Load wheel dependencies (amd64, 12.6) / Finalize ✅ success view
Load wheel dependencies (amd64, 12.6) / Metadata ✅ success view
Load wheel dependencies (amd64, 13.0) / Caching ✅ success view
Load wheel dependencies (amd64, 13.0) / Finalize ✅ success view
Load wheel dependencies (amd64, 13.0) / Metadata ✅ success view
Load wheel dependencies (arm64, 12.6) / Caching ✅ success view
Load wheel dependencies (arm64, 12.6) / Finalize ✅ success view
Load wheel dependencies (arm64, 12.6) / Metadata ✅ success view
Load wheel dependencies (arm64, 13.0) / Caching ✅ success view
Load wheel dependencies (arm64, 13.0) / Finalize ✅ success view
Load wheel dependencies (arm64, 13.0) / Metadata ✅ success view
Prepare cache clean-up ❔ in_progress view
Retrieve PR info ✅ success view
✅ Required checks (6/6) — declared in .github/required-checks.yml for push
Required check Status Link
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Python) ✅ success view

@1tnguyen

1tnguyen commented Jun 6, 2026

Copy link
Copy Markdown
Collaborator

We have a few spell check errors: we can either escape them with backsticks or adding valid words to the spelling_allowlist.txt file.

Signed-off-by: Shane Caldwell <scaldwell@nvidia.com>
Signed-off-by: Shane Caldwell <scaldwell@nvidia.com>
Signed-off-by: Shane Caldwell <scaldwell@nvidia.com>
@caldwellshane caldwellshane force-pushed the codex/realtime-hsb-ip-docs branch from 88ee8e8 to 7b63602 Compare June 8, 2026 12:29
@caldwellshane

Copy link
Copy Markdown
Contributor Author

We have a few spell check errors: we can either escape them with backsticks or adding valid words to the spelling_allowlist.txt file.

Thanks @1tnguyen, I think it's fixed. I also made an extra commit to de-duplicate the references to the installation instructions, using the Sphinx docs as source of truth.

@caldwellshane caldwellshane marked this pull request as draft June 8, 2026 18:53
@caldwellshane

Copy link
Copy Markdown
Contributor Author

Converted to draft just now. The HSB core is now released, so I'll update the docs accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants