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.
Feature or Problem
When creating a prior PR, I noticed many Markdown linting errors in the Markdown docs which power wasmcloud.com. Using automated markdown linting can help ensure quality of wasmCloud.com documentation. This PR applies automated fixes, and adds a
justfile
and.markdownlint.yaml
file for fixing and checking for linting errors automatically.If the maintainers of the repo are open to this idea, then I would recommend first agreeing on the rules to ignore, fix the remaining markdownlint violations and then finally include a PR validation step in a GitHub workflow to check that all Markdown passes the linting check before allowing merges, before merging this PR.
Related Issues
N/A
Release Information
N/A
Consumer Impact
N/A
Testing
"It works on my machine" 😆
Unit Test(s)
N/A
Acceptance or Integration
N/A
Manual Verification
I have run
just lint-docs
andjust fix-docs
locally. There are still the following remaining linting errors which must be fixed by hand, but I won't proceed with those unless I know that the maintainers are open to this idea and this change is desireable: