From fce87cfdc99cb643c74e718003f4cfb65c0f08a3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ru=C3=A1n?= <ruan@murgatroyd.me>
Date: Mon, 12 Aug 2024 19:54:12 +0100
Subject: [PATCH] Added design vision for Wave 1 Voters

---
 README.md                | 6 +++---
 file-existence/README.md | 7 ++++++-
 link-resolver/README.md  | 7 ++++++-
 spell-check/README.md    | 7 ++++++-
 4 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f5147d0..24cbbf6 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,9 @@ Minimal modifications should be required to these voters to make them applicable
 
 ## Wave 1 Voters
 - [SonarQube](./sonarqube/)
-- Spell Check
-- File Existence Checks
-- Link Resolution Checks
+- [Spell Check](./spell-check/)
+- [File Existence Checks](./file-existence/)
+- [Link Resolution Checks](./link-resolver/)
 
 ## Wave 2 Voters
 - Container Build Checks
diff --git a/file-existence/README.md b/file-existence/README.md
index 792db86..67cb030 100644
--- a/file-existence/README.md
+++ b/file-existence/README.md
@@ -1,2 +1,7 @@
 # File Existence Voter
-TBF
\ No newline at end of file
+
+## Design Vision
+The file exisence voter should check that all files that are referenced actually exist in that path. This prevents broken links to files by way of typo, directory mistake or non-existing file.
+For .env or other files that should be excluded, there should be a file (maybe .gitignore?) that gives link exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any links fail to resolve.
\ No newline at end of file
diff --git a/link-resolver/README.md b/link-resolver/README.md
index 6b980d9..440c7c8 100644
--- a/link-resolver/README.md
+++ b/link-resolver/README.md
@@ -1,2 +1,7 @@
 # Link Resolution Voter
-TBF
\ No newline at end of file
+
+## Design Vision
+The link resolution voter should check all files for a URL by means of a regular expression (Except for localhost URLs) and ensure they actually resolve. This prevents broken links being introduced.
+For localhost or other links that should be excluded, there should be a file that gives link exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any links fail to resolve.
\ No newline at end of file
diff --git a/spell-check/README.md b/spell-check/README.md
index eddc5d7..53e62c2 100644
--- a/spell-check/README.md
+++ b/spell-check/README.md
@@ -1,2 +1,7 @@
 # Spell Check Voter
-TBF
\ No newline at end of file
+
+## Design Vision
+The spell check voter should check HTML, Markdown, READMEs, etc. (any file which contains text that would be read by a user) and verify correct spelling.
+For words specfic to the project, there should be a file which gives word exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any typos are detected.
\ No newline at end of file