Skip to content

learning/tools_for_ls: Fill in Matlab and Zephyr sections - #551

Merged
gastmaier merged 5 commits into
analogdevicesinc:workshops/just_enough_dataxfrom
GanscaTudor:matlab-zephyr-content
Jul 26, 2026
Merged

learning/tools_for_ls: Fill in Matlab and Zephyr sections#551
gastmaier merged 5 commits into
analogdevicesinc:workshops/just_enough_dataxfrom
GanscaTudor:matlab-zephyr-content

Conversation

@GanscaTudor

@GanscaTudor GanscaTudor commented Jul 24, 2026

Copy link
Copy Markdown

Type

  • [x ] Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

Summary

Follow-up to #507
Fill in MATLAB and Zephyr pages

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

Copy link
Copy Markdown
Contributor

LLM review

This series fills in the MATLAB and Zephyr tutorial pages under docs/learning/tools_for_ls/
and switches several child-page navigation links to :ref:.

run: 30170885703

2e77f75 - Fill in Matlab and Zephyr sections

Filename case: docs/learning/tools_for_ls/matlab_example/AD5592r_NPN_Curve_Tracer.png uses
mixed case, which case.py flags. Fixed by renaming to ad5592r_npn_curve_tracer.png and
updating the .. figure:: reference (see suggested patch below).

Content was cross-checked against the real Zephyr adi,ad559x MFD driver, the
adi_lsmspg shield overlay, the max32666fthr/max32655fthr board files, and the
PrecisionToolbox MATLAB source (+adi/+AD5592r/Rx.m, Attribute.m). Register names, node
labels, board targets, and API signatures all match upstream exactly - no factual issues found.

a7e0a69, 9401225, 7dc233e - :doc: to :ref: fixups

All 6 retargeted labels (datax-native-c-example, datax-matlab-example,
datax-iio-for-migrating, datax-no-os-standalone, datax-zephyr-example,
datax-ros2-integration) exist and resolve correctly. A full, non-sparse cd docs && make html
build of the whole tree completes with 0 warnings/errors.

CI warnings

The build-doc job fails with 4 undefined label: [ref.ref] warnings at
docs/learning/tools_for_ls/index.rst:451/498/520/566. This is a false positive of the
sparse-build mechanism used for incremental pushes
(.github/scripts/sphinx-build.sh + compute_sparse_config): since this push only touched
index.rst, matlab_example/, and zephyr_example/, the sparse config excludes sibling
directories native_c_example, tinyiiod_example, standalone_no-os_example, and
ros2_integration - which is exactly where the referenced labels live. Reverting the links to
:doc: and rebuilding under the same sparse config reproduces an equivalent
unknown document: [ref.doc] failure, confirming the exclusion (not the role choice) is the root
cause. No docs/ content change fixes this; it needs a tooling change (e.g. suppressing
ref.ref/ref.doc for sparse-excluded targets, similar to the existing toc.excluded
suppression, or building the strict gate against the full merge base).

Vale spelling failures on througout/mappped/ubiquitious in the same file predate this
range (introduced in 4abbd6b/c6aeb54, before 0ac828a) and are out of scope here.

Verification data

Verified technical claims against upstream sources: Zephyr's
include/zephyr/drivers/mfd/ad559x.h, boards/shields/adi_lsmspg/adi_lsmspg.overlay,
boards/adi/max32666fthr/max32666fthr_max32666_cpu0.dts, and PrecisionToolbox's
+adi/+AD5592r/Rx.m / ToolboxCommon/Attribute.m. Reproduced the CI sparse-build config locally
(adi_doctools.cli.serve.compute_sparse_config) to confirm the ref.ref/ref.doc false
positive, and ran case.py/dangling.py/vale to scope which findings belong to this commit
range.

Suggested patches

Apply the suggested patches with:

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

@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.

Sounds good!

Signed-off-by: Mr. Codeprüfer <llm@analog.com>
@gastmaier
gastmaier merged commit b1212d8 into analogdevicesinc:workshops/just_enough_datax Jul 26, 2026
2 of 3 checks passed
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.

2 participants