docs: add markdownlint workflow configuration and fix markdown issues#1975
Open
igoropaniuk wants to merge 4 commits intoqualcomm-linux:masterfrom
Open
docs: add markdownlint workflow configuration and fix markdown issues#1975igoropaniuk wants to merge 4 commits intoqualcomm-linux:masterfrom
igoropaniuk wants to merge 4 commits intoqualcomm-linux:masterfrom
Conversation
igoropaniuk
requested review from
anujm1,
koenkooi,
lumag,
ndechesne,
ricardosalveti,
sbanerjee-quic and
vkraleti
as code owners
igoropaniuk
force-pushed
the
docs/linter_and_improvements
branch
from
58ad235 to
9ff77ea
Compare
igoropaniuk
force-pushed
the
docs/linter_and_improvements
branch
from
9ff77ea to
721a6af
Compare
igoropaniuk
commented
Apr 16, 2026
igoropaniuk
changed the title
igoropaniuk
force-pushed
the
docs/linter_and_improvements
branch
3 times, most recently
from
0535b2c to
59eeec4
Compare
Contributor
Author
|
@lumag do you have GitHub Action configured to run workflows that already exist on the base branch (master)? I don't have any other explanations why the workflow introduced in this PR is not triggered |
Test run workflowTest jobs for commit 59eeec4
All jobs summary
|
Test Results 28 files ±0 28 suites ±0 1h 3m 41s ⏱️ + 4m 39s For more details on these failures, see this check. Results for commit 554dc01. ± Comparison against base commit b21d78a. This pull request removes 1 and adds 1 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Contributor
Not sure if you already got the answer to this. It didn't run because it needs to be added to allowed list first. |
Add a markdownlint configuration (.github/.markdownlint.yaml) and a GitHub Actions workflow to enforce consistent markdown style across the project. The workflow runs as a standalone check on pushes to master and on all pull requests when markdown files or the linter configuration change. Update paths-ignore in the PR build workflow to skip builds for markdown-only changes, since those are already covered by the standalone markdownlint workflow. Disabled rules: - MD013 (line length): existing docs exceed the default limit - MD033 (inline HTML): used throughout the documentation Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Add language specifiers to all fenced code blocks (MD040), use consistent dash style for unordered lists (MD004), and wrap bare URL in angle brackets (MD034). Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Fix extra space before period, correct "so to able" to "to be able", and fix "comminication" typo. Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Correct VID:PID order to match USB convention, use plural "branches" in the Branches section, and generalize the kirkstone-specific contribution note to cover all stable branches. Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
igoropaniuk
force-pushed
the
docs/linter_and_improvements
branch
from
59eeec4 to
554dc01
Compare
Contributor
Author
|
Pushed updated version |
Test run workflowTest jobs for commit 554dc01
All jobs summary
|
ricardosalveti
approved these changes
Apr 21, 2026
koenkooi
approved these changes
Apr 22, 2026
igoropaniuk
changed the title
Contributor
|
I still see:
so perhaps @mynameistechno can you please review and help? |
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
5 participants
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.
consistent markdown style on push/PR
use consistent list style, and wrap bare URLs
stable branch contribution note