7727405c25
docs: fix broken links, update versions and test counts
...
5-expert orchestrated cleanup audit findings:
- Fix broken security doc links (docs/SECURITY.md → doc/9-SECURITY.md)
- Update Go version requirement (1.21+ → 1.25.1+)
- Correct test count (39 → 44 test files)
- Fix ZOOM_IMPLEMENTATION.md filename reference
- Update last modified dates to 2025-12-02
2025-12-02 21:02:57 +00:00
949c9a0351
docs: Consolidate documentation into single doc/ folder
...
- Move docs/ contents to doc/ with proper numbering:
- CONTACT-FORM-QUICKSTART.md → 17-CONTACT-FORM.md
- SECURITY-AUDIT-REPORT.md → 18-SECURITY-AUDIT.md
- SECURITY.md → 19-SECURITY-IMPLEMENTATION.md
- Delete duplicate/redundant files from docs/:
- CMD-K-COMMAND-BAR.md (duplicate of 16-CMD-K-API.md)
- CONTACT_FORM_IMPLEMENTATION.md (overlaps with quickstart)
- SECURITY-IMPLEMENTATION-SUMMARY.md (summary of audit)
- Update doc/README.md with new document references
- Update test counts to 39 test files across all READMEs
- Update all "Last Updated" dates to 2025-12-01
- Add new API endpoints documentation (text, cmd-k, contact, toggles)
- Update PROJECT-MEMORY.md with new features and correct paths
2025-12-01 13:30:48 +00:00
025c10ac1f
docs: Add comprehensive backend handler documentation
...
Create public-facing documentation explaining backend architecture:
New Documentation:
- doc/14-BACKEND-HANDLERS.md (900+ lines)
* Handler architecture and file organization
* Request/response type system with examples
* Middleware pattern and preferences handling
* Comprehensive testing strategy
* Data flow diagrams and best practices
* Code examples for all major patterns
Updated:
- doc/README.md
* Add Backend Handlers to technical implementation section
* Update total active docs count (13 → 14)
* Add quick navigation links
Content Coverage:
- Handler responsibilities (pages, PDF, HTMX)
- Type-safe request handling with validation
- Middleware architecture and context usage
- Test coverage across all handler types
- Request processing flow diagrams
- Best practices with do/don't examples
Audience:
- Backend developers
- API consumers
- New contributors
- Technical documentation readers
Complements:
- Educational docs in _go-learning/refactorings/
- Internal architecture documentation
- API reference guide
2025-11-20 17:35:58 +00:00
9c5f0b20d8
docs: Add comprehensive toast notification test and documentation
...
Test Addition:
- Created tests/mjs/29-pdf-toast-notifications.test.mjs (22 assertions)
- Validates toast elements, JavaScript API, animations
- Tests both PDF download scenarios (modal stays open vs. closes early)
- Verifies toast lifecycle: prepare → progress → success → dismiss
- Tests icon/title/message updates and progress bar animation
Test Coverage:
✅ Toast DOM elements exist
✅ JavaScript functions available (showPDFToast, hidePDFToast)
✅ Manual toast trigger and auto-hide
✅ PDF modal integration - Scenario A (stay in modal)
✅ PDF modal integration - Scenario B (close modal, toast appears)
✅ Toast content updates (📥 → ✅ )
✅ Progress bar animation
✅ CSS animations defined (toastSlideIn, toastLifecycle, progressShrink)
Documentation Addition:
- Created doc/13-TOAST-NOTIFICATIONS.md (comprehensive guide)
- Architecture and component structure
- User experience flows (2 scenarios documented)
- JavaScript API reference (showPDFToast, hidePDFToast, showError)
- CSS structure and animations
- Template structure with ARIA accessibility
- PDF download integration details
- Accessibility features and testing guide
- Customization guide and troubleshooting
Documentation Updates:
- Updated doc/README.md (added entry #13 , total: 12 → 13 docs)
- Updated tests/README.md (test count: 27 → 28)
- Updated tests/TEST-SUMMARY.md (added toast notifications coverage)
- Updated tests/mjs/README.md (added test 29 description)
Test Count: 28 active tests
Doc Count: 13 core documents
Coverage: Complete UX feedback system with dual-mode operation
2025-11-20 13:05:46 +00:00
1258d61d05
refactor: Modularize CSS into ITCSS architecture + update documentation
...
CSS Refactoring:
- Split 2,287-line monolith into 6 focused modules
- New structure: Navigation, Scroll, Buttons, Modals, Zoom, Breakpoints
- Organized by ITCSS layers (Interactive + Responsive)
- 245 lines saved through better organization
- Site verified working at localhost:1999
New CSS Files:
- 04-interactive/_navigation.css (357 lines, 8.2KB)
- 04-interactive/_scroll-behavior.css (200 lines, 5.0KB)
- 04-interactive/_buttons.css (184 lines, 4.7KB)
- 04-interactive/_modals.css (487 lines, 16KB)
- 04-interactive/_zoom-control.css (253 lines, 6.3KB)
- 05-responsive/_breakpoints.css (561 lines, 14KB)
Documentation Updates:
- Added doc/12-CSS-ARCHITECTURE.md (comprehensive CSS guide)
- Updated doc/README.md (new entry + correct numbering)
- Updated tests/README.md (test count 8 → 27)
- Updated tests/TEST-SUMMARY.md (coverage expansion)
- Rewrote tests/mjs/README.md (complete test listing)
Removed:
- static/css/04-interactive/_remaining.css (replaced by modules)
2025-11-20 12:34:42 +00:00
1f6f8e417e
docs: Update skeleton loader implementation from hyperscript to JavaScript
...
MIGRATION SUMMARY:
- Moved skeleton loader logic from hyperscript to JavaScript (main.js)
- Changed from htmx:oobAfterSwap to htmx:afterSettle event
- Changed OOB swap from innerHTML to outerHTML for proper element replacement
- Added languageSwitching flag for state tracking
- Added 100ms delay after afterSettle for final render completion
DOCUMENTATION UPDATES:
- 2-MODERN-WEB-TECHNIQUES.md: Updated skeleton loader section with
2025-11-18 19:32:28 +00:00
65eb91b00b
docs: Rename 0-README.md to README.md (standard convention)
...
Keep README.md as the standard filename for better GitHub integration
and platform recognition. All other docs remain numbered (1-10).
2025-11-18 19:28:40 +00:00
3fa5d1e5ca
docs: Rename all documentation with numbered prefixes for clarity
...
RENAMING:
- README.md → 0-README.md (start here)
- ARCHITECTURE.md → 1-ARCHITECTURE.md (backend overview)
- MODERN-WEB-TECHNIQUES.md → 2-MODERN-WEB-TECHNIQUES.md (frontend architecture)
- API.md → 3-API.md (API reference)
- HYPERSCRIPT-RULES.md → 4-HYPERSCRIPT-RULES.md (conventions)
- ZOOM_IMPLEMENTATION.md → 5-ZOOM-IMPLEMENTATION.md (zoom feature)
- USER_GUIDE.md → 6-USER-GUIDE.md (user docs)
- CUSTOMIZATION.md → 7-CUSTOMIZATION.md (customization guide)
- DEPLOYMENT.md → 8-DEPLOYMENT.md (deployment)
- SECURITY.md → 9-SECURITY.md (security)
- PRIVACY.md → 10-PRIVACY.md (privacy policy)
CROSS-REFERENCE UPDATES:
- Updated all internal links in all documentation files
- Updated README navigation with numbered references
- Added # column to documentation tables
- Made all links use numbered filenames
BENEFITS:
✅ Clear reading order (0-10)
✅ Logical progression (overview → technical → user → ops → compliance)
✅ Easy sorting and navigation
✅ Professional organization
✅ Zero broken links
2025-11-18 19:12:50 +00:00
81e8b3c25e
docs: Clean up documentation directory - eliminate redundancy
...
CLEANUP SUMMARY:
- Moved to archive: 3 files (historical/debugging docs)
- ZOOM-CONTROL-FIX-REPORT.md
- ZOOM-FIXES-COMPLETE-SUMMARY.md
- PROJECT_IMPROVEMENT_SUMMARY.md.ASPIRATIONAL → PROJECT_IMPROVEMENT_SUMMARY.md
- Deleted: 1 file (duplicate content)
- COLOR-THEME-IMPLEMENTATION.md (content already in MODERN-WEB-TECHNIQUES.md)
- Created: 1 file (navigation index)
- README.md with complete documentation navigation
RESULT:
- Before: 14 files (403 lines redundant)
- After: 11 files (clean, organized, zero redundancy)
- Archive: 20 files (properly categorized historical docs)
BENEFITS:
- Zero documentation duplication
- Clear navigation structure
- Canonical source for each topic
- Historical docs preserved in archive
2025-11-18 18:59:41 +00:00
juanatsap