Skip to content

Update TMC application notes links - #280

Open
Amekyras wants to merge 1 commit into
Frix-x:mainfrom
Amekyras:patch-1
Open

Update TMC application notes links#280
Amekyras wants to merge 1 commit into
Frix-x:mainfrom
Amekyras:patch-1

Conversation

@Amekyras

@Amekyras Amekyras commented Apr 19, 2026

Copy link
Copy Markdown

Changed the TMC AN notes to the ones on Analog's page that are still live, and added archives for the ones that aren't

Summary by Sourcery

Documentation:

  • Refresh TMC application note URLs in the vibration profile documentation to use live Analog Devices pages and archived links for no-longer-available documents.

Changed the TMC AN notes to the ones on Analog's page that are still live, and added archives for the ones that aren't
@sourcery-ai

sourcery-ai Bot commented Apr 19, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates documentation links in the vibrations profile macro guide to point to current Analog Devices-hosted TMC application notes and archived copies for notes no longer live on the Trinamic site.

Flow diagram for updated TMC application note link mapping

flowchart TD
  A[User clicks TMC_AN_link in vibrations_profile_guide]
  A --> B{Which_AN?}

  B -->|AN001| AN001_new[Open https://www.analog.com/en/resources/app-notes/an-001.html]
  B -->|AN002| AN002_new[Open https://www.analog.com/en/resources/app-notes/an-002.html]
  B -->|AN003| AN003_new[Open https://www.analog.com/en/resources/app-notes/an-003.html]
  B -->|AN009| AN009_archive[Open archived AN009 at web.archive.org]
  B -->|AN015| AN015_new[Open https://www.analog.com/en/resources/app-notes/an-015.html]
  B -->|AN021| AN021_archive[Open archived AN021 at web.archive.org]

  AN001_new --> C[User reads note and tunes parameters]
  AN002_new --> C
  AN003_new --> C
  AN009_archive --> C
  AN015_new --> C
  AN021_archive --> C
Loading

File-Level Changes

Change Details Files
Refresh TMC application note references in the vibrations profile documentation to use live Analog Devices URLs and web-archived backups.
  • Replace AN001–AN003 links from legacy trinamic.com PDF URLs to corresponding analog.com application note pages.
  • Update AN009 link to use a Web Archive snapshot of the original Trinamic PDF since a live vendor page is unavailable.
  • Replace the AN015 link with the corresponding analog.com application note page.
  • Update the AN021 link to a Web Archive snapshot of the original Trinamic PDF while retaining its descriptive context in the text.
docs/macros/create_vibrations_profile.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • Consider explicitly noting in the text that AN009 and AN021 are archived links (e.g., “archived copy of AN009”) so readers understand why those URLs differ from the others.
  • For consistency and resilience, you might want to standardize the link format (e.g., always using https://www.analog.com/... where available and only falling back to web.archive.org when no Analog-hosted version exists), and ensure all used AN numbers follow the same URL pattern.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider explicitly noting in the text that AN009 and AN021 are archived links (e.g., “archived copy of AN009”) so readers understand why those URLs differ from the others.
- For consistency and resilience, you might want to standardize the link format (e.g., always using https://www.analog.com/... where available and only falling back to web.archive.org when no Analog-hosted version exists), and ensure all used AN numbers follow the same URL pattern.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

1 participant