Skip to content

solutions/reference-design/ad57xx-ardz: added docs for ad57xx - #542

Open
reyolmedo wants to merge 2 commits into
analogdevicesinc:mainfrom
reyolmedo:docs/ad57xx
Open

solutions/reference-design/ad57xx-ardz: added docs for ad57xx#542
reyolmedo wants to merge 2 commits into
analogdevicesinc:mainfrom
reyolmedo:docs/ad57xx

Conversation

@reyolmedo

@reyolmedo reyolmedo commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

@gastmaier gastmaier added the llm review Request a review from a LLM Reviewer label Jul 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

LLM review

This series adds documentation for the EVAL-AD57XXARDZ precision DAC evaluation board family, covering the AD5760/AD5780/AD5781/AD5790/AD5791 devices with quickstart guides for Cora Z7S and DE10-Nano FPGA carriers.

run: 29590971838

86e21bb - ad57xx docs

BOM in index.rst: index.rst starts with a UTF-8 BOM (0xEF 0xBB 0xBF) which causes incorrect rendering and shifts vale line-number reporting.

Vale failures — Linux vs linux: The ADI vocabulary (accept.txt) defines linux as the accepted lowercase form. Nine occurrences of Linux in plain text across index.rst, prerequisites.rst, and quickstart/coraz7s.rst trigger vale:Vale.Terms CI failures.

Grid indentation bug in index.rst: The .. grid:: directive showing the eval board images is indented 3 spaces, nesting it inside the last Applications: bullet item. It should be at column 0.

Figure indentation bug in quickstart/de10nano.rst: The AD57xx/DE10-Nano setup figure is indented 3 spaces inside its section, making it a block quote rather than a directive.

Raw URLs instead of :adi: role in user-guide.rst: The UG-2209 and UG-2225 user guide links use raw https://www.analog.com/media/... URLs. The convention throughout the repo is to use the :adi: role.

Redundant custom titles on build_hdl references: :external+hdl:ref:Build an HDL project <build_hdl> repeats the label's own title unnecessarily. Should be `:external+hdl:ref:`build_hdl.

CI warnings

The vale:Vale.Terms warning for :git-no-os: (line 138 of index.rst, col 20) is a false positive — vale scans the role name git-no-os as plain text and flags no-os as wrong. The role name cannot be changed.

The check-doc case warnings (ADIN1110_Hw_Config.png, TeraTerm.png, etc.) are pre-existing and unrelated to this PR.

Verification data

  • Built with adoc serve --once --sparse docs/solutions/reference-designs/ad57xx-ardz — 0 errors.
  • Ran vale --config=.github/styles/vale-enforcement.ini on all 6 .rst files — 0 errors after fixes.
  • Fetched https://www.analog.com/media/en/en-pdf-sitemap.xml to confirm UG-2209 and UG-2225 exist.
  • Verified intersphinx labels (ad57xx_ardz, build_hdl, build_guide, use-kuiper-image) against published HDL, no-OS, and Kuiper inventory files.

Suggested patches

Apply the suggested patches with:

cd path/to/repository
export GITHUB_TOKEN=ghp_***
apply-patches --repo=analogdevicesinc/documentation 29590971838
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.

reyolmedo and others added 2 commits July 20, 2026 19:40
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@StancaPop
StancaPop self-requested a review August 7, 2026 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

llm review Request a review from a LLM Reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants