Skip to content

Conversation

@soumeh01
Copy link
Collaborator

@soumeh01 soumeh01 commented May 7, 2025

Changes

  • This change introduces an automated Markdown linter and link checker job.
    The goal is to ensure that all changes to Markdown files follow consistent formatting standards and that any URLs included are valid and reachable. If any issues are detected, the workflow will fail and provide detailed output, highlighting the exact lines with errors along with clear error messages.

@soumeh01 soumeh01 requested review from KeilChris and jreineckearm May 7, 2025 18:59
@soumeh01 soumeh01 marked this pull request as ready for review May 7, 2025 18:59
Copy link
Collaborator

@KeilChris KeilChris left a comment

Choose a reason for hiding this comment

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

Can you wait with this PR until #215 is merged, please? I have changed the documentation content and this would end up in a blocked merge.

@soumeh01
Copy link
Collaborator Author

soumeh01 commented May 8, 2025

Can you wait with this PR until #215 is merged, please? I have changed the documentation content and this would end up in a blocked merge.

Make sense. Let's wait for your PR to merge, and then I will rework the touched files.

@jreineckearm
Copy link
Collaborator

Sorry, this needs to resolve conflicts coming with merge of #215

@soumeh01 soumeh01 force-pushed the markdown-checker branch from cb1e6f0 to 3622553 Compare May 8, 2025 11:51
@soumeh01 soumeh01 force-pushed the markdown-checker branch from b986988 to 66dce5e Compare May 8, 2025 11:59
@soumeh01 soumeh01 requested a review from KeilChris May 8, 2025 12:02
@soumeh01
Copy link
Collaborator Author

soumeh01 commented May 8, 2025

Can you wait with this PR until #215 is merged, please? I have changed the documentation content and this would end up in a blocked merge.

Merged your changes and applied the formatting rules on them. Please review

@soumeh01
Copy link
Collaborator Author

soumeh01 commented May 8, 2025

Sorry, this needs to resolve conflicts coming with merge of #215

Resolved

jreineckearm
jreineckearm previously approved these changes May 8, 2025
Copy link
Collaborator

@jreineckearm jreineckearm left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes and taking care of the initial conversion!
I'd lie if I'd say I understand all the config files yet. But I trust your knowledge here. :-)

Good to merge as far as I am concerned. But we may want to wait for @KeilChris to lift his change request.

Copy link
Collaborator

@KeilChris KeilChris left a comment

Choose a reason for hiding this comment

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

We must preserve the four spaces before sub-bulletpoints, otherwise the documentation build will create unexpected results.

KeilChris
KeilChris previously approved these changes May 8, 2025
Copy link
Collaborator

@KeilChris KeilChris left a comment

Choose a reason for hiding this comment

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

LTGM

@soumeh01 soumeh01 force-pushed the markdown-checker branch from 9739c05 to 573fde6 Compare May 8, 2025 13:17
@soumeh01 soumeh01 requested review from KeilChris and jreineckearm May 8, 2025 13:20
Copy link
Collaborator

@jreineckearm jreineckearm left a comment

Choose a reason for hiding this comment

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

LGTM! CI seems happy now

Copy link
Collaborator

@KeilChris KeilChris left a comment

Choose a reason for hiding this comment

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

LGTM

@jreineckearm jreineckearm merged commit 7a01014 into main May 8, 2025
13 checks passed
@jreineckearm jreineckearm deleted the markdown-checker branch May 8, 2025 14:24
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.

4 participants