Add validation quality checks

Author: Evan1108-Coder

.github/workflows/validate.yml

@@ -0,0 +1,22 @@
+name: Validate Docs
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Run validation
+        run: node scripts/validate.js
+

CONTRIBUTING.md

@@ -24,5 +24,13 @@ Thanks for helping improve GitHub Docs Templates.
 2. Create a branch.
 3. Make your change.
 4. Check that links work.
-5. Open a pull request with a short explanation.
+5. Run `node scripts/validate.js` if you can.
+6. Open a pull request with a short explanation.
 
+## Quality Check
+
+Before opening a pull request, this command can catch common mistakes:
+
+```bash
+node scripts/validate.js
+```

QUALITY.md

@@ -0,0 +1,25 @@
+# Quality Checks
+
+This repository includes a small validation script to catch common documentation mistakes.
+
+## Run Checks
+
+```bash
+node scripts/validate.js
+```
+
+## What It Checks
+
+- Markdown relative links point to real files.
+- Required root files are present.
+- Every starter pack has its expected files.
+- Every template category has its own `README.md` guide.
+- A few common typo or naming mistakes are not present.
+
+## GitHub Actions
+
+The same validation runs automatically on pushes and pull requests through:
+
+```text
+.github/workflows/validate.yml
+```

README.md

@@ -30,6 +30,16 @@ If you want to choose individual files instead, use `templates/`.
 
 For a compact list of the most useful templates, see [TEMPLATE_INDEX.md](TEMPLATE_INDEX.md).
 
+## Quality Checks
+
+This repository includes a small validation script:
+
+```bash
+node scripts/validate.js
+```
+
+It checks relative links, starter packs, and template folder guides. See [QUALITY.md](QUALITY.md).
+
 ## Do I Need All Of This?
 
 No. This repository includes many docs because different projects need different things.
@@ -87,6 +97,7 @@ When you use a template in your own repository, rename it to the standard GitHub
 - `examples/` - complete example documentation sets for common project types.
 - `guides/` - beginner explanations, checklists, and glossary.
 - `TEMPLATE_INDEX.md` - compact index of common copy paths.
+- `QUALITY.md` - validation notes for maintaining the repository.
 
 ## Placeholder Style
 

scripts/validate.js

@@ -0,0 +1,193 @@
+const fs = require("fs");
+const path = require("path");
+
+const root = process.cwd();
+const starterPacks = [
+  "starter-packs/personal-project",
+  "starter-packs/open-source-library",
+  "starter-packs/web-app",
+  "starter-packs/cli-tool",
+  "starter-packs/docs-site",
+];
+
+const expectedStarterFiles = {
+  "starter-packs/personal-project": [
+    "README.md",
+    "LICENSE",
+    "CONTRIBUTING.md",
+  ],
+  "starter-packs/open-source-library": [
+    "README.md",
+    "LICENSE",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT.md",
+    "SECURITY.md",
+    ".github/ISSUE_TEMPLATE/bug_report.md",
+    ".github/ISSUE_TEMPLATE/feature_request.md",
+    ".github/PULL_REQUEST_TEMPLATE.md",
+  ],
+  "starter-packs/web-app": [
+    "README.md",
+    "SECURITY.md",
+    "SUPPORT.md",
+    ".github/ISSUE_TEMPLATE/bug_report.md",
+  ],
+  "starter-packs/cli-tool": [
+    "README.md",
+    "CONTRIBUTING.md",
+    "CHANGELOG.md",
+  ],
+  "starter-packs/docs-site": [
+    "README.md",
+    "CONTRIBUTING.md",
+    ".github/ISSUE_TEMPLATE/documentation.md",
+  ],
+};
+
+function walk(dir) {
+  const files = [];
+
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (entry.name === ".git") continue;
+
+    const fullPath = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...walk(fullPath));
+    } else {
+      files.push(fullPath);
+    }
+  }
+
+  return files;
+}
+
+function fail(message) {
+  console.error(message);
+  process.exitCode = 1;
+}
+
+function checkMarkdownLinks() {
+  const missing = [];
+  const files = walk(root).filter((file) => file.endsWith(".md"));
+  const linkPattern = /\[[^\]]+\]\((?!https?:|mailto:|#)([^)]+)\)/g;
+
+  for (const file of files) {
+    const text = fs.readFileSync(file, "utf8");
+    let match;
+
+    while ((match = linkPattern.exec(text))) {
+      const rawTarget = match[1].split("#")[0];
+      if (!rawTarget) continue;
+
+      const target = decodeURIComponent(rawTarget);
+      const fullTarget = path.normalize(path.join(path.dirname(file), target));
+
+      if (!fs.existsSync(fullTarget)) {
+        missing.push(`${path.relative(root, file)} -> ${match[1]}`);
+      }
+    }
+  }
+
+  if (missing.length) {
+    fail(`Missing markdown links:\n${missing.join("\n")}`);
+  } else {
+    console.log("Markdown relative links OK");
+  }
+}
+
+function checkStarterPacks() {
+  for (const pack of starterPacks) {
+    const fullPath = path.join(root, pack);
+
+    if (!fs.existsSync(fullPath)) {
+      fail(`Missing starter pack: ${pack}`);
+      continue;
+    }
+
+    for (const file of expectedStarterFiles[pack]) {
+      const filePath = path.join(fullPath, file);
+
+      if (!fs.existsSync(filePath)) {
+        fail(`Starter pack is missing ${file}: ${pack}`);
+      }
+    }
+
+    console.log(`Starter pack OK: ${pack}`);
+  }
+}
+
+function checkRootFiles() {
+  const required = [
+    "README.md",
+    "QUICKSTART.md",
+    "TEMPLATE_INDEX.md",
+    "LICENSE",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT.md",
+    "SECURITY.md",
+  ];
+
+  for (const file of required) {
+    if (!fs.existsSync(path.join(root, file))) {
+      fail(`Missing root file: ${file}`);
+    }
+  }
+
+  console.log("Root files OK");
+}
+
+function checkTemplateReadmes() {
+  const templatesDir = path.join(root, "templates");
+  const missing = [];
+
+  for (const entry of fs.readdirSync(templatesDir, { withFileTypes: true })) {
+    if (!entry.isDirectory()) continue;
+
+    const readmePath = path.join(templatesDir, entry.name, "README.md");
+    if (!fs.existsSync(readmePath)) {
+      missing.push(`templates/${entry.name}/README.md`);
+    }
+  }
+
+  if (missing.length) {
+    fail(`Missing template folder guides:\n${missing.join("\n")}`);
+  } else {
+    console.log("Template folder guides OK");
+  }
+}
+
+function checkUnwantedText() {
+  const unwanted = ["Placholder", "github-docs-templates"];
+  const matches = [];
+
+  for (const file of walk(root)) {
+    if (file.includes(`${path.sep}.git${path.sep}`)) continue;
+    if (path.relative(root, file) === "scripts/validate.js") continue;
+
+    const text = fs.readFileSync(file, "utf8");
+
+    for (const word of unwanted) {
+      if (text.includes(word)) {
+        matches.push(`${path.relative(root, file)} contains ${word}`);
+      }
+    }
+  }
+
+  if (matches.length) {
+    fail(`Unwanted text found:\n${matches.join("\n")}`);
+  } else {
+    console.log("Unwanted text check OK");
+  }
+}
+
+checkMarkdownLinks();
+checkRootFiles();
+checkStarterPacks();
+checkTemplateReadmes();
+checkUnwantedText();
+
+if (process.exitCode) {
+  process.exit(process.exitCode);
+}
+
+console.log("All validation checks passed");