[WIP] Fix typos and resolve broken links in documentation

[Copilot]

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Fix all the typos and resolve broken links</issue_title>
<issue_description># [Tracker] Comprehensive documentation audit: Fix broken links (404s) and orthographic errors

📋 Executive Summary

This issue tracks the progress of a repository-wide audit aimed at resolving accumulated "documentation debt." Upon reviewing the current state of the README.md, /docs directory, and inline code comments, I have identified a significant number of broken hyperlinks (404 errors), deprecated internal references, and typographical inconsistencies.

This is a maintenance task focused on Quality Assurance (QA) and Developer Experience (DX).

🚩 The Problem

High-quality documentation is critical for developer adoption, ease of use, and project maintainability. Currently, the repository suffers from:

1. Link Rot (404 Errors): Several internal relative links point to files that have been moved, renamed, or deleted in previous refactors. This creates "dead ends" for users trying to navigate the docs.
2. Dead External References: Links to third-party libraries, external articles, and API definitions are outdated, leading to dead domains or generic landing pages.
3. Typos & Orthographic Errors: Spelling errors in code comments and user-facing documentation lower the perceived professionalism of the project. In some cases, typos in variable names (e.g., recieve vs receive) are causing cognitive friction during code reviews.
4. Asset Failures: Certain images and diagrams referenced in the Markdown are failing to render.

🕵️ Audit Findings (Evidence)

Below is a non-exhaustive list of the specific issues identified during the initial scan:

1. Critical Broken Links (High Priority)

• Location: README.md (Installation Section)
  • Issue: The link to docs/SETUP.md returns a 404 because the file was moved to .github/SETUP.md.
• Location: docs/api/index.md
  • Issue: The external link to the dependency documentation returns a 502 Bad Gateway (domain no longer exists).
• Location: Footer Navigation
  • Issue: "Contact Support" link redirects to a generic home page instead of the help desk.

2. Typos & Grammar (Medium Priority)

• Location: src/utils/helpers.js
  • Issue: Docstring mentions @param {string} paramater (misspelled).
• Location: docs/contributing.md
  • Issue: "Enviroment variables" is misspelled in the setup header.
• Location: Global
  • Issue: Inconsistent capitalization of "API" vs "Api" throughout comments.

🎯 Scope of Work & Action Items

The objective is to clean up these errors without altering functional code logic.

Phase 1: Link Remediation

• Run automated link checker (e.g., markdown-link-check) across the full docs/ directory.
• Update all internal relative paths to match current file structure.
• Replace dead external links with Archive.org snapshots or updated vendor URLs.
• Remove hyperlinks that are permanently dead and have no replacement.

Phase 2: Textual Cleanup

• Run spell-checker (e.g., cspell) against the codebase.
• Correct spelling errors in README.md and all Markdown files.
• Fix typos in code comments (Docstrings, JSDoc, inline comments).
• Optional: Fix internal variable naming typos only if they are private/local and do not break public APIs.

Phase 3: Verification

• Verify that all images/assets render correctly on GitHub.
• Ensure the build pipeline passes (no syntax errors introduced).

📉 Impact of Inaction

Leaving these issues unresolved leads to:

• Poor Onboarding: New contributors get frustrated when links to setup guides fail.
• SEO Degradation: Search engines penalize documentation sites with high bounce rates caused by broken links.
• Reduced Trust: Visible typos suggest a lack of attention to detail in the codebase.

🛠️ Tools Used for Detection

• Manual review
• VS Code Spell Check
• Broken Link Checker
  </issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Fix all the typos and resolve broken links #74

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.