Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add linting action for documentation #119

Merged
merged 8 commits into from
May 23, 2024
Merged

Add linting action for documentation #119

merged 8 commits into from
May 23, 2024

Conversation

dgaliffiAMD
Copy link
Collaborator

Addresses Issue: 53

@dgaliffiAMD
Add linking workflow
6296dc1 
Signed-off-by: David Galiffi <[email protected]>
@dgaliffiAMD
Copy link
Collaborator Author

Starting the process, but need to fix the existing errors first.

@dgaliffiAMD dgaliffiAMD force-pushed the amd/dgaliffi/doc-lint branch from 6fcb48c to 758ec64 Compare May 16, 2024 04:22
@dgaliffiAMD
Fix markdownlint errors
3924ff9 
Signed-off-by: David Galiffi <[email protected]>
@dgaliffiAMD dgaliffiAMD force-pushed the amd/dgaliffi/doc-lint branch from d5c785c to 3924ff9 Compare May 16, 2024 16:18
@dgaliffiAMD dgaliffiAMD marked this pull request as ready for review May 16, 2024 16:19
@dgaliffiAMD dgaliffiAMD requested a review from a team as a code owner May 16, 2024 16:19
@dgaliffiAMD dgaliffiAMD requested review from Beanavil, Naraenda and a team and removed request for a team May 16, 2024 16:19
@dgaliffiAMD
Copy link
Collaborator Author

Fixed the markdownlint errors in the project.

@dgaliffiAMD dgaliffiAMD linked an issue May 16, 2024 that may be closed by this pull request
Please add linting to this project based on https://github.com/RadeonOpenCompute/ROCm/blob/develop/.github/workflows/linting.yml #53
Closed
@dgaliffiAMD dgaliffiAMD requested a review from saadrahim May 16, 2024 16:22
Naraenda
Naraenda requested changes May 22, 2024
View reviewed changes
Copy link
Member

@Naraenda Naraenda left a comment

Choose a reason for hiding this comment

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

The markdown improvements look good. I had a problem with some of the code-blocks turning into math-blocks and a few minor nits, but other than that LGTM.

Applications/prefix_sum/README.md Outdated Show resolved Hide resolved
Dockerfiles/README.md Outdated Show resolved Hide resolved
HIP-Basic/matrix_multiplication/README.md Outdated Show resolved Hide resolved
HIP-Basic/runtime_compilation/README.md Outdated Show resolved Hide resolved
LLVM_ASAN/Using-Address-Sanitizer-with-a-Short-HIP-Application.md Outdated Show resolved Hide resolved
LLVM_ASAN/Using-Address-Sanitizer-with-a-Short-HIP-Application.md Outdated Show resolved Hide resolved
Libraries/rocSPARSE/level_2/bsrmv/README.md Outdated Show resolved Hide resolved
dgaliffiAMD
dgaliffiAMD commented May 22, 2024
View reviewed changes
Copy link
Collaborator Author

@dgaliffiAMD dgaliffiAMD left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the feedback. I have made your suggested changes.

LLVM_ASAN/Using-Address-Sanitizer-with-a-Short-HIP-Application.md Outdated Show resolved Hide resolved
LLVM_ASAN/Using-Address-Sanitizer-with-a-Short-HIP-Application.md Outdated Show resolved Hide resolved
@dgaliffiAMD dgaliffiAMD requested a review from Naraenda May 22, 2024 16:51
Naraenda
Naraenda approved these changes May 23, 2024
View reviewed changes
Copy link
Member

@Naraenda Naraenda left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@dgaliffiAMD dgaliffiAMD merged commit c707559 into develop May 23, 2024
2 checks passed
@dgaliffiAMD dgaliffiAMD deleted the amd/dgaliffi/doc-lint branch May 23, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Naraenda Naraenda Naraenda approved these changes

@Beanavil Beanavil Awaiting requested review from Beanavil

@saadrahim saadrahim Awaiting requested review from saadrahim

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@dgaliffiAMD @Naraenda