Update TMC application notes links - #280
Open
Amekyras wants to merge 1 commit into
Open
Conversation
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
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates 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 mappingflowchart 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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: