docs: add linter for markdown documents #3133
Merged
Conversation
This file contains 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
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
charleenfei,
damiannolan,
chatton and
tmsdkeys
as code owners
9 tasks
damiannolan
approved these changes
Feb 10, 2023
# Conflicts: # docs/ibc/proto-docs.md # e2e/README.md
… into carlos/markdown-lint
stackman27
pushed a commit
to stackman27/ibc-go
that referenced
this pull request
Mar 13, 2023
Co-authored-by: Jacob Gadikian <jacobgadikian@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR is based on @faddat's idea to link the markdown documents. I have created a new PR from a different branch because it was easier for me to handle the conflicts and address @colin-axner's comment.
I will make sure to add @faddat as co-author when merging.
closes: #XXXX
Commit Message / Changelog Entry
N/A
see the guidelines for commit messages. (view raw markdown for examples)
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.