feat: add markdown links checker (#43)

* feat: add markdown links checker to check all Markdown files for broken links

* feat: disable codecov on patch

* fix: revert the previous commit

* chore: bump link check version to the latest and change folder path to check all markdown files

* test: test without scheduled runs

* test: pull request and push

* fix: revert schedule back

* chore: fix markdown links check and add CONTRIBUTING.md file

* fix: broken links in markdown files

* fix: last broken link

.github/workflows/linkchecker.yml

@@ -0,0 +1,19 @@
+name: Check Markdown links
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - develop
+  schedule: 
+    - cron: '* */24 * * *'
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/[email protected]
+        with:
+          folder-path: "."

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+TODO: add context

docs/Explanation/ADR/README.md

@@ -36,4 +36,4 @@ When writing ADRs, follow the same best practices for writing RFCs. When writing
 
 ## ADR Table of Contents
 
-- [ADR XXX: Self Sovereign Identity](./adr-001-self-sovereign-identity.md)
+- [ADR 002: Documentation Structure](./adr-002-docs-structure.md)

docs/Explanation/README.md

@@ -24,28 +24,12 @@ For further background information please see [the ADR relating to the documenta
 
 The scope and structure of the Explanation documentation follows this layout.
 
-### Topics
-
-Topics are discursive documents that explore some particular feature or theme.  For example, an article might investigate Decentralised Identity Documents or Self-Sovereign Identity.
-
-To contribute, create a folder in [topics](./topics) with a self-descriptive name. Add your content as needed.
-
-### Presentations
-
-The [Presentations](PRESENTATIONS.md) file describes and links to presentations about Budget module at various events. Presentations also include YouTube videos,  podcasts, interviews, and so on. 
-
-
 ### Architecture Decisions Records (ADRs)
 
  ADRs are the mechanism for contributors to raise design proposals. In turn, the ADRs explain for subsequent contributors the rationale behind Budget module design and implementation. For example, [ADR 002: Documentation Structure](./ADR/adr-002-docs-structure.md) explains why the Budget module documentation structure was chosen. 
 
 See the Architecture Decision Records (ADR) [README](./ADR/README.md) file for more details about how to raise and propose an ADR.
 
-### Articles
-
-This folder contains all articles relating to Budget module, includes papers, blog posts, and so on. For details, see [Articles README](articles/README.md).
-
-
 ## Discussions
 
 The explanation content includes articles, topics, and so on, and also includes discussion on relevant channels, including [Pull Requests](https://github.com/tendermint/budget/pulls) and [Issues](https://github.com/tendermint/budget/issues). Important Pull Requests are listed in this document.
@@ -57,7 +41,7 @@ Future: Budget module currently doesn't have a Discord or Telegram Channel. When
 * All documentation is written following [Google Documentation Best Practice](https://google.github.io/styleguide/docguide/best_practices.html)
 * Autogenerate documentation from the code whenever possible.
 * Raise a PR for all documentation changes
-* Follow our [Code of Conduct](../CONTRIBUTING.md)
+* Follow our [Code of Conduct](../../CONTRIBUTING.md)
 
 ## Reference
 

docs/How-To/api/README.md

@@ -9,10 +9,10 @@ Description: A high-level overview of gRPC-gateway REST Routes in budget module.
 
 ## gRPC-gateway REST Routes
 
-In order to test out the following REST routes, you need to set up a local node to query from. You can refer to this [localnet tutorial](./Tutorials/localnet) on how to build `budgetd` binary and bootstrap a local network in your local machine.
+In order to test out the following REST routes, you need to set up a local node to query from. You can refer to this [localnet tutorial](../../Tutorials/localnet) on how to build `budgetd` binary and bootstrap a local network in your local machine.
 
 Query the values set as budget parameters
-http://localhost:1317/cosmos/budget/v1beta1/params
+http://localhost:1317/cosmos/budget/v1beta1/params <!-- markdown-link-check-disable-line -->
 
 ```json
 {
@@ -33,7 +33,7 @@ http://localhost:1317/cosmos/budget/v1beta1/params
 ```
 
 Query all the budget plans exist in the network
-http://localhost:1317/cosmos/budget/v1beta1/budgets
+http://localhost:1317/cosmos/budget/v1beta1/budgets <!-- markdown-link-check-disable-line -->
 
 ```json
 {

docs/How-To/cli/README.md

@@ -9,7 +9,7 @@ This document provides a high-level overview of how the command-line (CLI) inter
 
 ## Command-Line Interfaces
 
-In order to test out the following command-line interfaces, you need to set up a local node to either send transaction or query from. You can refer to this [localnet tutorial](./Tutorials/localnet) on how to build `budgetd` binary and bootstrap a local network in your local machine.
+In order to test out the following command-line interfaces, you need to set up a local node to either send transaction or query from. You can refer to this [localnet tutorial](../../Tutorials/localnet) on how to build `budgetd` binary and bootstrap a local network in your local machine.
 
 - [Transaction N/A](#Transaction)
 - [Query](#Query)

docs/README.md

@@ -16,7 +16,6 @@ This approach outlines four specific use cases for documentation:
 * [Tutorials](./Tutorials/README.md)
 * [How-Tos](./How-To/README.md)
 * [Explanation](./Explanation/README.md)
-* [Reference](./Reference/README.md)
 
 For further background please see [the ADR relating to the documentation structure](./Explanation/ADR/adr-002-docs-structure.md). 
 

docs/Tutorials/demo/README.md

@@ -1,3 +1,4 @@
 # Demo
 
+<!-- markdown-link-check-disable-next-line -->
 - [Budget & Farming MVP demo](https://github.com/tendermint/farming/blob/master/docs/Tutorials/demo/budget_with_farming.md)