Update AD-JUPITER system level documentation

[hadarauelena]

Type

• Documentation
• Bug fix
• New feature
• Continuous integration

Checklist

• I have performed a self-review of changes
• I have followed the guidelines:
  • https://analogdevicesinc.github.io/documentation/contributing/docs_guidelines.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/index.html
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#documentation-structure
• I have used the appropriate roles and directives:
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/directives.html
• I ensured that binary data was committed to git lfs:
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#adding-images-and-other-binary-files
• I have built the pages I edited or created, using either make html or adoc serve:
  • https://analogdevicesinc.github.io/doctools/cli.html#serve
• I have signed-off my commits and believe my contribution improves the repository.

[github-actions]

LLM review

This series restructures the AD-JUPITER-EBZ documentation (major overhaul of index, quickstart, hardware-overview, mcs-setup, production-testing) and adds a Sphinx label to the zynqmp DisplayPort section to replace a broken dokuwiki cross-reference.

run: 29255114709

082a83b - ad-jupiter-ebz: Update system level documentation

Wrong HDL cross-reference: The Table of Contents points adrv9001 for the Jupiter SDR HDL project, but the correct label is jupiter_sdr (verified in the HDL intersphinx inventory). mcs-setup.rst in the same directory correctly uses jupiter_sdr.

vale failure BaseBand: Line 130 uses BaseBand which should be baseband per the Vale.Terms rule.

dokuwiki link still used for imported page: The GNU Radio link (:dokuwiki:\GNU Radio <resources/tools-software/linux-software/gnuradio>`) can be replaced with :ref:`GNU Radio `` — the page is already in this repository.

ec83dd8 - linux/kernel/zynqmp: Add label for the display port section

vale AMD-Xilinx warnings: Two instances of Xilinx (without preceding AMD) at lines 87 and 98 trigger Enforcement.AMD-Xilinx warnings: section title "Using the Xilinx toolchain" and text "Find the path to the Xilinx installation folder".

CI warnings

The vale:Vale.Terms failures for JUPITER in AD-JUPITER-EBZ are false positives — these are product names inside :adi: roles and page titles. The Linux → linux failures at zynqmp.rst:3 and index.rst:35 are pre-existing issues not introduced by this PR (same pattern in the un-touched zynq.rst).

Global improvement

The GNU Radio dokuwiki link pattern :dokuwiki:\GNU Radio <resources/tools-software/linux-software/gnuradio>`appears in 14 additional files across the repository. Patch 0004 replaces all with:ref:`GNU Radio ``.

Verification data

• adoc serve --once --sparse solutions/reference-designs/ad-jupiter-ebz linux/kernel — clean build after applying patches.
• HDL intersphinx at https://analogdevicesinc.github.io/hdl/objects.inv confirms jupiter_sdr label exists.

Suggested patches

Apply the suggested patches with:

cd path/to/repository
export GITHUB_TOKEN=ghp_***
apply-patches --repo=analogdevicesinc/documentation 29255114709

Install instructions

The following one-liner installs the script if not present already:

curl -fSsL "https://raw.githubusercontent.com/analogdevicesinc/doctools/refs/heads/main/ci/scripts/apply-patches.sh" \
     -o ~/.local/bin/apply-patches.sh && \
  grep -q "/apply-patches.sh" ~/.bashrc || echo "source ~/.local/bin/apply-patches.sh" >> $_ ; . $_

More information at AI Usage.

[github-actions]

LLM review

This series restructures the AD-JUPITER-EBZ documentation (major overhaul of index, hardware-overview, quickstart, mcs-setup, production-testing) and adds a Sphinx label to the zynqmp DisplayPort section to enable proper cross-references.

run: 29322909658

f1e4422 - ad-jupiter-ebz: Update system level documentation

Content Quality: Index restructured from flat "User Resources" to hierarchical Table of Contents with clear sections for "Using the evaluation board", "Design with the ADRV9002", and "Help and Support". All 73 images reorganized into centralized images/ directory with references updated.

Vale Failures: Three capitalization errors that should be fixed:

• Line 35: "Linux and no-OS" should be "linux and no-OS"
• Line 38: "MATLAB" should be "Matlab"
• hardware-overview.rst line 158: "Linux running" should be "linux running"

Documentation Quality: ✓ Text properly reformatted, import marker present, all deleted files (profile-generation.rst, reference-design.rst, jupiter-dma-coeherent.tar.gz) properly removed from toctree with no dangling references.

1b0f58f - linux/kernel/zynqmp: Add label for the display port section

Change: Added Sphinx label .. _zynqmp displayport-no-picture: before DisplayPort troubleshooting section.

Vale Failures: Two capitalization errors that should be fixed:

• Line 3: "Build ZynqMP / MPSoC Linux kernel" should be "Build ZynqMP / MPSoC linux kernel"
• Line 214: "Linux Kernel on the" should be "linux kernel on the"

Section Title: Updated from "Using the Xilinx toolchain" to "Using the AMD Xilinx toolchain" (correct per Vale.Enforcement.AMD-Xilinx rule).

Vale Failures (5 total)

The vale checker reports 5 capitalization issues across these commits:

zynqmp.rst:

Line 3:   "Linux kernel" → "linux kernel"  
Line 214: "Linux Kernel" → "linux kernel"

ad-jupiter-ebz/index.rst:

Line 35: "Linux and no-OS" → "linux and no-OS"
Line 38: "MATLAB" → "Matlab"

ad-jupiter-ebz/hardware-overview.rst:

Line 158: "Linux running" → "linux running"

These are all legitimate failures where text (not product names in roles) violates the Vale.Terms rule.

Verification

• Built documentation cleanly: sphinx-build -W -b html → PASS
• All intersphinx references verified present:
  • external+hdl:ref:jupiter_sdr (verified against HDL inventory)
  • external+linux:ref:adrv9002 (verified)
  • external+no-OS:doc:projects/rf-transceiver/adrv9001 (verified)
• Image reorganization: 73 images moved to images/ with all references updated
• Deleted files confirmed not referenced elsewhere
• Label format .. _zynqmp displayport-no-picture: correct and unique

Suggested Patches

Apply the suggested patches with:

cd path/to/repository
export GITHUB_TOKEN=ghp_***
apply-patches --repo=analogdevicesinc/documentation 29322909658

Install instructions

The following one-liner installs the script if not present already:

curl -fSsL "https://raw.githubusercontent.com/analogdevicesinc/doctools/refs/heads/main/ci/scripts/apply-patches.sh" \
     -o ~/.local/bin/apply-patches.sh && \
  grep -q "/apply-patches.sh" ~/.bashrc || echo "source ~/.local/bin/apply-patches.sh" >> ~/.bashrc ; \
  source ~/.bashrc

More information at AI Usage.

[StancaPop]

Looks good to me.