Documentation Center

README.md

The primary documentation for this repository. Covers deployment status, responsive design, analytics setup, testing, code quality standards, and commit signing requirements. This is your starting point for understanding the entire project.

QUICK_START.md

A 5-minute setup guide for enabling automatic commit signing using the Free For Charity GPG key. Includes step-by-step instructions for adding the public key to GitHub and configuring repository secrets.

DEPLOYMENT.md

Comprehensive guide for deploying this Next.js site to GitHub Pages. Covers Next.js configuration for static export, custom domain setup, GitHub Actions workflow, build output structure, and troubleshooting common deployment issues.

.github/workflows/README.md

Documentation for the three GitHub Actions workflows: CI (continuous integration with testing and linting), CodeQL Analysis (automated security scanning), and Deploy (production deployment to GitHub Pages).

CODE_QUALITY.md

Comprehensive overview of code quality standards including ESLint configuration, TypeScript type safety, testing framework (Jest + React Testing Library), security scanning, and recommendations for enhancements. Essential reading for maintaining high code quality.

TEST_CASES.md

Detailed documentation of all test cases including build output validation, GitHub Pages configuration, SEO metadata, route generation, and configuration validation. Explains the test framework, coverage goals, and maintenance procedures.

/testing

Comprehensive public-facing test documentation covering all 17 test suites, their purposes, what they test, why they are important, and how to verify them manually. Includes running instructions, CI/CD integration details, and test result interpretation. Essential for understanding the testing strategy and quality assurance processes.

QUICK_START.md

Comprehensive 5-minute setup guide for enabling automatic GPG commit signing. Includes step-by-step instructions, verification procedures, troubleshooting, how auto-signing works, and advanced topics. Consolidated from multiple GPG documentation files for easy access.

GPG_SIGNING.md

Technical documentation explaining why GPG signatures are required, how GitHub verifies signatures, and five different solutions for enabling commit signing including repository settings, GitHub Apps, bot configuration, and workflow automation.

gpg-keys/README.md

Documentation for the official Free For Charity GPG key including key information (ID, fingerprint, validity period), security warnings, setup instructions, and verification procedures. Explains how to safely manage public and private keys.

RESPONSIVE_DESIGN.md

Complete responsive design documentation covering Tailwind CSS breakpoints, navigation behavior across devices (mobile hamburger menu vs desktop inline links), expected behavior at different screen sizes, comprehensive troubleshooting guide for cache and CSS loading issues, and detailed testing and verification results.

ISSUE_RESOLUTION.md

Comprehensive analysis and resolution of issues encountered during development. Documents problems, root causes, solutions implemented, and lessons learned. Valuable resource for troubleshooting similar issues in the future.

docs/archived/README.md

Documentation that has been archived includes: SETUP_AUTO_SIGNING.md and AUTO_SIGN_TEST.md (consolidated into QUICK_START.md), RESPONSIVE_TESTING_RESULTS.md (consolidated into RESPONSIVE_DESIGN.md), and IMPLEMENTATION_ISSUES.md (all 11 issues complete). Files are preserved for historical reference and audit purposes.