Skip to content

Adc platforms triton#427

Open
IDerringtonADI wants to merge 7 commits intomainfrom
adc-platforms-triton
Open

Adc platforms triton#427
IDerringtonADI wants to merge 7 commits intomainfrom
adc-platforms-triton

Conversation

@IDerringtonADI
Copy link
Copy Markdown
Collaborator

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

Typos and gramar fixed
Signed-off-by: ANALOG\IDerring <iain.derrington@analog.com>
@github-actions
Copy link
Copy Markdown
Contributor

LLM review

This series adds Dual Triton MultiChip Sync (MCS) Pilot documentation under docs/solutions/platforms/triton/ — covering Aion EVB initialization, Triton platform initialization, and Python script execution — plus adds the Triton platform card to the Platforms index.

run: 24575875872


7c4f5f2 - Addition of missing image / b844772 - HTML removed. Typos and grammar fixed

Build failure — image filename typo (critical):
aion-init/index.md references dual-triton-mcs-aion-bsync-1-3-alignment.png but the file was committed as dual-triton-mcs-aion-bysnc-1-3-alignment.png (note: bysnc vs bsync). This causes the Sphinx [image.not_readable] build failure.

Case violations (CI warnings):
Three image filenames have uppercase letters and must be renamed:

  • resources/ADXBAND16EBZ_top-angle-evaluation-board.png -> adxband16ebz_top-angle-evaluation-board.png
  • triton/images/ADXBAND16EBZ-top-angle-evaluation-board.png -> adxband16ebz-top-angle-evaluation-board.png
  • triton/images/ADXBAND16EBZ-available-configurations.png -> adxband16ebz-available-configurations.png

Dangling files (CI warnings):

  • python-exe/image.png is not referenced by any .rst or .md file
  • aion-init/images/dual-triton-mcs-aion-bysnc-1-3-alignment.png becomes dangling after the rename fix

Wrong placeholder links:
In dual-triton-mcs/index.md, the HDL image links point to a Mini-Circuits product page instead of a placeholder:

- [Triton Leader HDL Image](https://www.minicircuits.com/WebStore/.../ZC4PD-5R263-S%2B)
- [Triton Follower HDL Image](https://www.minicircuits.com/WebStore/.../ZC4PD-5R263-S%2B)

These should be plaintext placeholders consistent with the existing {warning} admonition.

Raw HTML <br> tags:
triton/index.md and triton-init/index.md use raw <br> tags. Remove them; the line break is not needed.

Invalid ****text**** bold markers:
Both aion-init/index.md and triton-init/index.md use ****text**** for emphasis, which is not valid Markdown. Use {attention} admonitions instead.

Typos in python-exe/index.md:

  • Line 18: "one these are executed" -> "once these are executed"
  • Line 91: "will measure me the NCO Phase" -> "will measure the NCO Phase"

Trailing whitespace: Present in all new .md files.


CI warnings

The Sphinx [image.not_readable] failure for dual-triton-mcs-aion-bsync-1-3-alignment.png is directly caused by the filename typo. The three uppercase-filename warnings are pre-existing patterns for other files in the repo but the new files should not repeat them.

Verification data

Built with sphinx-build -b html locally after applying fixes — no Triton or Aion related errors or warnings remain. Ran python3 .github/scripts/dangling.py and python3 .github/scripts/case.py — both clean for the changed files after fixes.

Suggested patches

Apply the suggested patches with:

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

Signed-off-by: ANALOG\IDerring <iain.derrington@analog.com>
@gastmaier
Copy link
Copy Markdown
Collaborator

Hi, can you also apply the llm patches and keep the changes that are useful, thanks

https://github.com/analogdevicesinc/documentation/actions/runs/24575875872/artifacts/6500651023

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants