chore(docs): consolidate 22 audit files from root into docs/audits/
Root directory had accumulated audit/exploration markdown files cluttering the project root. Moved all audit-related files to docs/audits/ with a README.md index, and updated cross-references in K6_LOAD_TESTING_GUIDE.md and README_FRONTEND_DOCS.md. Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
77
docs/audits/README.md
Normal file
77
docs/audits/README.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Audit Reports
|
||||
|
||||
All audit and exploration reports for the GoodGo Platform, generated during code review and quality assessment cycles.
|
||||
|
||||
## Quick Start
|
||||
|
||||
| Goal | Start Here |
|
||||
|------|------------|
|
||||
| Full codebase overview | [COMPREHENSIVE_CODEBASE_AUDIT.md](COMPREHENSIVE_CODEBASE_AUDIT.md) |
|
||||
| Code quality & patterns | [CODE_QUALITY_AUDIT.md](CODE_QUALITY_AUDIT.md) |
|
||||
| Test coverage gaps | [AUDIT_SUMMARY.txt](AUDIT_SUMMARY.txt) (then [TEST_COVERAGE_AUDIT.md](TEST_COVERAGE_AUDIT.md)) |
|
||||
| Accessibility status | [ACCESSIBILITY_QUICK_SUMMARY.txt](ACCESSIBILITY_QUICK_SUMMARY.txt) |
|
||||
| Admin module deep-dive | [ADMIN_AUDIT_INDEX.md](ADMIN_AUDIT_INDEX.md) |
|
||||
| API quality | [API_AUDIT_REPORT.md](API_AUDIT_REPORT.md) |
|
||||
| Frontend analysis | [FRONTEND_EXPLORATION.md](FRONTEND_EXPLORATION.md) |
|
||||
|
||||
---
|
||||
|
||||
## Index by Category
|
||||
|
||||
### General / Cross-Cutting
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [AUDIT_INDEX.md](AUDIT_INDEX.md) | 4.4 KB | Master index of code quality and test audits |
|
||||
| [AUDIT_SUMMARY.txt](AUDIT_SUMMARY.txt) | 8.4 KB | Executive summary dashboard |
|
||||
| [COMPREHENSIVE_CODEBASE_AUDIT.md](COMPREHENSIVE_CODEBASE_AUDIT.md) | 15 KB | Full architecture review |
|
||||
| [CODE_QUALITY_AUDIT.md](CODE_QUALITY_AUDIT.md) | 21 KB | Code style, patterns, and quality analysis |
|
||||
|
||||
### Accessibility
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [ACCESSIBILITY_QUICK_SUMMARY.txt](ACCESSIBILITY_QUICK_SUMMARY.txt) | 3.9 KB | Quick summary of a11y findings |
|
||||
| [ACCESSIBILITY_FINDINGS_SUMMARY.txt](ACCESSIBILITY_FINDINGS_SUMMARY.txt) | 20 KB | Detailed a11y findings |
|
||||
| [ACCESSIBILITY_AUDIT_INDEX.md](ACCESSIBILITY_AUDIT_INDEX.md) | 9.1 KB | Index for accessibility audit docs |
|
||||
| [ACCESSIBILITY_AUDIT_2026-04-10.md](ACCESSIBILITY_AUDIT_2026-04-10.md) | 47 KB | Full accessibility audit (2026-04-10) |
|
||||
| [ACCESSIBILITY_AUDIT_QUICK_REFERENCE.md](ACCESSIBILITY_AUDIT_QUICK_REFERENCE.md) | 8.6 KB | A11y quick reference guide |
|
||||
| [ACCESSIBILITY_CODE_FIXES_INDEX.md](ACCESSIBILITY_CODE_FIXES_INDEX.md) | 7.1 KB | Index of applied a11y code fixes |
|
||||
| [ACCESSIBILITY_DETAILED_FIXES.md](ACCESSIBILITY_DETAILED_FIXES.md) | 8.9 KB | Detailed a11y fix descriptions |
|
||||
| [ACCESSIBILITY_FIXES_REPORT.md](ACCESSIBILITY_FIXES_REPORT.md) | 8.4 KB | Summary of a11y fixes applied |
|
||||
|
||||
### Admin Module
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [ADMIN_AUDIT_INDEX.md](ADMIN_AUDIT_INDEX.md) | 14 KB | Index for admin module audit |
|
||||
| [ADMIN_AUDIT_EXPLORATION.md](ADMIN_AUDIT_EXPLORATION.md) | 24 KB | Admin module exploration and analysis |
|
||||
| [ADMIN_AUDIT_QUICK_FILES.md](ADMIN_AUDIT_QUICK_FILES.md) | 9.0 KB | Quick file reference for admin module |
|
||||
| [ADMIN_AUDIT_ARCHITECTURE.md](ADMIN_AUDIT_ARCHITECTURE.md) | 28 KB | Admin module architecture deep-dive |
|
||||
|
||||
### API
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [API_AUDIT_REPORT.md](API_AUDIT_REPORT.md) | 11 KB | API quality and consistency audit |
|
||||
|
||||
### Frontend
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [FRONTEND_EXPLORATION.md](FRONTEND_EXPLORATION.md) | 19 KB | Frontend codebase exploration and analysis |
|
||||
| [FRONTEND_AUDIT_2026-04-10.md](FRONTEND_AUDIT_2026-04-10.md) | 9.2 KB | Frontend audit (2026-04-10) |
|
||||
|
||||
### Test Coverage
|
||||
|
||||
| File | Size | Description |
|
||||
|------|------|-------------|
|
||||
| [TEST_AUDIT_README.md](TEST_AUDIT_README.md) | 8.5 KB | Guide to test audit documents |
|
||||
| [TEST_COVERAGE_AUDIT.md](TEST_COVERAGE_AUDIT.md) | 28 KB | Comprehensive test coverage analysis |
|
||||
| [TEST_COVERAGE_QUICK_REFERENCE.md](TEST_COVERAGE_QUICK_REFERENCE.md) | 13 KB | Test coverage quick lookup |
|
||||
|
||||
---
|
||||
|
||||
## Generated
|
||||
|
||||
All reports generated during April 2026 codebase review cycle.
|
||||
Reference in New Issue
Block a user