Skip to content

solutions: ref-designs: added EVAL-LTPA-LNAKIT documentation - #604

Merged
gastmaier merged 3 commits into
analogdevicesinc:mainfrom
ALUyie:ltpa-documentation
Oct 8, 2026
Merged

gastmaier merged 3 commits into
analogdevicesinc:mainfrom
ALUyie:ltpa-documentation

Conversation

@ALUyie

@ALUyie ALUyie commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

Signed-off-by: Allan Uy <Allan.Uy@analog.com>
@jvelasc2
jvelasc2 requested a review from gastmaier September 24, 2026 07:07
@jvelasc2 jvelasc2 added human This content was made by a human llm review Request a review from a LLM Reviewer labels Sep 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

LLM review

This series adds the EVAL-LTPA-LNAKIT reference design page (a new add-on
kit for the EVAL-LTPA-KIT / LTpowerAnalyzer™).

Session: 35968045296

e930794 - Add EVAL-LTPA-LNAKIT documentation

Dangling figure reference: line 81 hardcodes "Figure 8 illustrates the
basic hardware setup...", but with numfig enabled the referenced figure
(hw-setup-noise) is actually Figure 6 on this page (5 figures precede it:
the hero image + the 4-image gain-profile grid). This text looks copied
from the original source with the wrong figure number. Replaced with a
:numref: reference to a named figure so it can't drift again.

Broken :ez: role target: :ez:`EngineerZone Support Community <ez/reference-designs>` resolves to
https://ez.analog.com/ez/reference-designs — the ez segment is doubled,
since the role already prefixes https://ez.analog.com. Fixed to
<reference-designs>, matching the dominant convention elsewhere in
docs/solutions/reference-designs/*. Note the same wrong pattern already
exists in eval-ltpa-kit/index.rst and a few other pages predating this
PR — out of scope here but worth a follow-up cleanup.

Typos: freqeuncies -> frequencies, and LNAmplifier Controls ->
LNA Controls (the rest of the page consistently says "LNA").

Also cleaned up trailing whitespace and a stray double space introduced by
the new page.

CI warnings

The vale failures for LNAmplifier and freqeuncies are real typos,
fixed by the attached patch. The pcs failure is a false positive
(abbreviation for "pieces"), left as-is.

The 5x "Cannot scale image!" / "Could not obtain image size" Sphinx
warnings were reproduced locally: git lfs pull fetches valid PNGs and the
page builds without warnings. Re-writing the same 5 images (the hero image
and the 4 grid gain-profile images) back to their raw LFS pointer text
reproduces the exact same warnings/line numbers seen in the CI log. This
points to a transient LFS fetch/smudge failure in that specific CI run, not
a defect in the page or the committed images — re-running the job should
clear it.

Verification data

No datasheet exists for this kit (checked the ADI PDF sitemap and
adoc search-wiki, no hits), and the page is not a dokuwiki import, so
there was no external source to diff against. Verification was limited to
rebuilding the page (adoc serve --once --sparse solutions/reference-designs/eval-ltpa-lnakit and cd docs && make dirhtml), inspecting the generated HTML to confirm the new :numref:
resolves to "Figure 6", and running vale --config=.github/styles/vale-spelling.ini
before/after the fix.

Suggested patches

  • 0001-fixup-solutions-ref-designs-added-EVAL-LTPA-LNAKIT-d.patch (e930794) — fixes the dangling figure reference, the broken :ez: role target, two typos, and whitespace cleanup.

Apply with:

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


.. figure:: EVAL-LTPA-LNAKIT_top-evaluation-board.png
:align: center
:scale: 20%

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

can we remove all :scale:, it is not used anywhere else.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Apologies for the delay. All instances of :scale: have been removed.

Comment on lines +84 to +85
|

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Are those "wiki to .rst" conversion artifacts? please clean-up

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Cleaned up now. Thanks!

Allan Uy added 2 commits October 8, 2026 09:35
Signed-off-by: Allan Uy <Allan.Uy@analog.com>
…moved image scaling and empty lines

Signed-off-by: Allan Uy <Allan.Uy@analog.com>
@ALUyie
ALUyie requested a review from gastmaier October 8, 2026 01:46

@gastmaier gastmaier left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks!

@gastmaier
gastmaier merged commit 524a001 into analogdevicesinc:main Oct 8, 2026
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