Skip to content

Conversation

@v-singh1
Copy link
Contributor

No description provided.

Copy link
Member

@cshilwant cshilwant left a comment

Choose a reason for hiding this comment

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

Apart from the other feedbacks, comments from vale and commit check workflow needs to be addressed

vale warnings at - https://github.com/TexasInstruments/processor-sdk-doc/pull/355/files#diff-c3ca6facf690bd9373acdba648b491b7255559ecbe93abb8a115e47f861924c8

commit check error at - https://github.com/TexasInstruments/processor-sdk-doc/actions/runs/16195790963/job/45721822147?pr=355

feat(Demo Application): Add Audio-DSP-Offload Linux example as commit message title should be fine. Also, a short commit message can be added

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Demo_User_Guides/AM62D_Dsp_Offload_User_Guide.rst:66: (ERROR/3) Unexpected indentation.

@github-actions
Copy link

New unreachable files found with check-files.sh:

source/images/AM62D_com_ports.png
source/images/AM62D_linux_login.jpg

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Demo_User_Guides/AM62D_Dsp_Offload_User_Guide.rst:4: (WARNING/2) Title underline too short.

@v-singh1 v-singh1 requested a review from cshilwant July 14, 2025 03:20
cshilwant
cshilwant previously approved these changes Jul 14, 2025
@v-singh1
Copy link
Contributor Author

@StaticRocket @praneethbajjuri can you please review.

@glneo
Copy link
Contributor

glneo commented Jul 14, 2025

Can you use SVG for graphics where possible?

As for images, the "Host GUI Utility" image has multiple of the same step number, but none of this is explained.

It also uses the word "Date" instead of "data".

@v-singh1 v-singh1 dismissed stale reviews from praneethbajjuri and cshilwant via 9429602 July 14, 2025 16:15
@v-singh1
Copy link
Contributor Author

Can you use SVG for graphics where possible?

As for images, the "Host GUI Utility" image has multiple of the same step number, but none of this is explained.

It also uses the word "Date" instead of "data".

Addressed review comments.

Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

As initially requested please address the vale comments on spelling, active voice, etc.

You may ignore the note about common abbreviations.

Also, you'll need to remove the excess : in your commit. Proper formatting would be feat(demos): AM62D Audio-DSP-Offload Linux example

@v-singh1 v-singh1 changed the title AM62D: Demo Application: Add Audio-DSP-Offload Linux example AM62D OOB: Audio-DSP-Offload Linux example Jul 14, 2025
@v-singh1
Copy link
Contributor Author

As initially requested please address the vale comments on spelling, active voice, etc.

You may ignore the note about common abbreviations.

Also, you'll need to remove the excess : in your commit. Proper formatting would be feat(demos): AM62D Audio-DSP-Offload Linux example

Addressed review comments, acronyms and below 2 warnings are left as they are required.

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'AM62D DSP offload from Linux - User Guide'.

[vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'tell' rather than 'Notify'.

Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

Some spelling issues that were truncated due to API rate limits from other warnings

AM62D out-of-box general purpose DSP offload example documentation

Signed-off-by: Vishnu Singh <[email protected]>
@cshilwant cshilwant dismissed praneethbajjuri’s stale review July 15, 2025 03:58

Author has updated the PR

@jeevantelukula jeevantelukula merged commit 9b76f07 into TexasInstruments:master Jul 15, 2025
5 of 6 checks passed
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.

8 participants