Skip to content

wiki-migration: add docs for eval-ad7405fmc#396

Open
reyolmedo wants to merge 1 commit intoanalogdevicesinc:mainfrom
reyolmedo:docs/ad7405
Open

wiki-migration: add docs for eval-ad7405fmc#396
reyolmedo wants to merge 1 commit intoanalogdevicesinc:mainfrom
reyolmedo:docs/ad7405

Conversation

@reyolmedo
Copy link
Copy Markdown

@reyolmedo reyolmedo commented Mar 31, 2026

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

@reyolmedo reyolmedo marked this pull request as ready for review March 31, 2026 11:01
@StancaPop StancaPop self-requested a review April 1, 2026 08:10
@StancaPop StancaPop added the human This content was made by a human label Apr 1, 2026
@StancaPop StancaPop closed this Apr 1, 2026
@StancaPop StancaPop reopened this Apr 1, 2026
@StancaPop
Copy link
Copy Markdown
Collaborator

Reopened this PR to trigger the deployment.

Copy link
Copy Markdown
Collaborator

@StancaPop StancaPop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some build errors that need to be fixed.

Copy link
Copy Markdown
Collaborator

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments to pass CI/CD

Comment thread docs/solutions/reference-designs/ad7405-fmc/index.rst Outdated
Comment thread docs/solutions/reference-designs/ad7405-fmc/quickstart/sdp_h1.rst Outdated
Comment thread docs/solutions/reference-designs/ad7405-fmc/quickstart/sdp_h1.rst Outdated
@reyolmedo
Copy link
Copy Markdown
Author

@gastmaier done updated your suggested changes.

@reyolmedo reyolmedo force-pushed the docs/ad7405 branch 2 times, most recently from 97c45a2 to af53cfa Compare April 6, 2026 05:25
@gastmaier
Copy link
Copy Markdown
Collaborator

/home/runner/work/documentation/documentation/docs/solutions/reference-designs/ad7405-fmc/user-guide.rst:18: WARNING: undefined label: 'ad7405 quickstart ad7405_sdp_h1' [ref.ref]

@gastmaier
Copy link
Copy Markdown
Collaborator

gastmaier commented Apr 10, 2026

@gastmaier gastmaier added the llm review Request a review from a LLM Reviewer label Apr 23, 2026
@github-actions
Copy link
Copy Markdown
Contributor

LLM review

This series adds EVAL-AD7405FMCZ evaluation board documentation (16-bit isolated sigma-delta ADC, LVDS interface), migrated from the UG-690 PDF user guide. No DokuWiki source was found for this board.

run: 24828070638

b650b5b - wiki-migration: add docs for eval-ad7405fmc

Critical typo: docs/solutions/reference-designs/ad7405-fmc/index.rst:26 says
6 bits, no missing codes — should be 16 bits, no missing codes. Verified against
both the AD7405 datasheet and UG-690 (both clearly say "16 bits"). The leading 1
was dropped during transcription.

Figure numbering inconsistency: quickstart/sdp_h1.rst uses RST-based figure
numbers (1–13) for the first set of figures, then switches to PDF-based numbers
(14–22) starting at the "Control Buttons" section. The RST has 21 figures (not 22
as in the PDF — the "typical setup" figure was omitted). This makes references like
"labeled 2 in Figure 14" wrong; the main window is Figure 13 in the RST. All
figure references from 14 onward are off by one.

Table reference bug: quickstart/sdp_h1.rst:64 Quick Start Guide says
"configured as outlined in Table 2" but the RST's Link Options table is Table 1
(the RST dropped the PDF's Table 1: External Power Supplies, shifting the numbering).

Inaccurate description: user-guide.rst:20 says "jumper settings corresponding
to the selected boot mode" — the EVAL-AD7405FMCZ has no boot modes; it uses link
options for power supply selection only.

Raw PDF link: user-guide.rst:8 uses a raw https://www.analog.com/... URL;
the pattern for similar pages uses the :adi: role.

Trailing whitespace and missing EOF newlines in index.rst, prerequisites.rst,
user-guide.rst, and quickstart/sdp_h1.rst.

Verification data

UG-690 (eval-ad7405fmcz_ug-690.pdf) and AD7405 datasheet were fetched and
converted to text with PyMuPDF. The connector table, link options table, feature
list, and figure sequence were compared line-by-line against the RST content to
identify the issues above. The build was verified clean before and after fixes with
cd docs; make html.

Suggested patches

Apply the suggested patches with:

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

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

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

More information at AI Usage.

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

Labels

human This content was made by a human llm review Request a review from a LLM Reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants