ci: add linting workflow for docs (markdown + spelling)#100
Open
ci: add linting workflow for docs (markdown + spelling)#100
Conversation
nikhilsk
force-pushed
the
chore/add-linting-workflow
branch
3 times, most recently
from
1e6f0da to
c8f4f85
Compare
nikhilsk
force-pushed
the
chore/add-linting-workflow
branch
from
c8f4f85 to
1c52018
Compare
shiv-tyagi
reviewed
Mar 5, 2026
| @@ -0,0 +1,37 @@ | |||
| name: Linting | |||
Member
There was a problem hiding this comment.
Why are we not using rocm's standard doc linting workflow here?
| AMD_CTK_PATH=$(CURDIR)/bin/$(BIN_DIRECTORY_SUFFIX)/amd-ctk go test -v ./... | ||
|
|
||
| # Docs lint (Markdown + spelling; matches CI linting checks) | ||
| DOCS_MARKDOWNLINTCONFIG ?= .markdownlint.yaml |
Member
There was a problem hiding this comment.
Can we check what ROCm/rocm-docs-core/.github/workflows/linting.yml uses and add similar targets here (for local runs) while using the same job in CI?
That would help us in reducing extra maintenance of these targets.
| docs-lint-docker-build: ## Build the docs-lint image locally (for Dockerfile changes or first-time setup). | ||
| docker build -t $(DOCS_LINT_IMAGE) -f $(CURDIR)/tools/docs-lint/Dockerfile $(CURDIR)/tools/docs-lint | ||
|
|
||
| docs-lint-docker-push: docs-lint-docker-build ## Build and push the docs-lint image to the registry (for maintainers/CI). |
Member
There was a problem hiding this comment.
This kind of maintenance I am taking about. We should use something where we don't have to worry about all this.
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
3 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.
Motivation
Technical Details
Test Plan
Test Result
Submission Checklist