docs(workflows): Add PR link check and nightly check using markdown-l…

…ink-check (#79)

* docs(workflows): Add PR link check

* readme with broken link

* fix broken links

* rename pr file; add nightly file

.github/workflows/markdown-link-check-nightly.yml

@@ -0,0 +1,19 @@
+name: Check Markdown Links Nightly
+
+on:
+  push:
+    branches:
+      - master
+  schedule:
+    # Run everyday at 2:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
+    - cron: "0 2 * * *"
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'

.github/workflows/markdown-link-check-pull-request.yml

@@ -0,0 +1,14 @@
+name: PR Link Check
+
+on: [pull_request]
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          check-modified-files-only: 'yes'

README.md

@@ -9,22 +9,12 @@ The latest version of the docs is the `master` branch.
 The site has built-in support for [Mermaid](https://mermaid-js.github.io/mermaid/), which is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. <i>Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs to be spent on documenting, as a separate and laborious task. Even non-programmers can create diagrams through the Mermaid Live Editor.</i>
 
 Mermaid resources:
-- [Quick Start](https://mermaid-js.github.io/mermaid/getting-started/n00b-gettingStarted.html)
-- [Tutorials](https://mermaid-js.github.io/mermaid/getting-started/Tutorials.html)
+- [Quick Start](http://mermaid.js.org/intro/getting-started.html)
+- [Tutorials](hhttp://mermaid.js.org/config/Tutorials.html)
 - [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) - create your diagrams visually and copy the generated Mermaid code to your page
 
 The theme also supports PlantUML and draw.io.
 
-## Dev
-
-Start the dev server
-
-```bash
-make dev
-```
-
-Open the dev site [http://localhost:9001](http://localhost:9001) and start editing content, server supports live reloading.
-
 ## Cloning the project
 
 [Contributor's Guide](https://docs.armory.io/contribute)
@@ -155,3 +145,6 @@ See the GitHub [docs](https://help.github.com/en/github/collaborating-with-issue
 
 The Armory documentation uses New Relic to monitor the website status and other metrics.
 
+## Link checks
+
+The repo uses [Markdown link check](https://github.com/marketplace/actions/markdown-link-check) to check static links in a PR.