Repository: Hestenb62/_legacy_backup
Author: Hesten Berger
Commit Message: Update README.md
URL: https://github.com/Hestenb62/_legacy_backup/commit/f700e0970e34ef9c31506e675a4815d11c66fe20
Code Changes:
diff --git a/README.md b/README.md
index 75c6b92..6f20510 100644
--- a/README.md
+++ b/README.md
@@ -21,46 +21,58 @@ The project is structured logically around server-side templating (PHP) and clea
```text
├── assets/ # Static resources
│ ├── css/ # Cascading style layers
-│ │ ├── tokens.css # Core theme variables & design tokens
-│ │ ├── reset.css # Zero-specificity base resets and font overrides
-│ │ ├── primitives.css # Accessibility tools, spotlight, & overlays
-│ │ ├── utilities.css # General utility helper classes
-│ │ ├── components.css # Main layout and widget design systems
-│ │ └── components/ # Specific component styles (fixed-tools.css, etc.)
+│ │ ├── global-tokens.css # Core theme variables & design tokens
+│ │ ├── global-reset.css # Zero-specificity base resets and font overrides
+│ │ ├── global-primitives.css # Accessibility tools, spotlight, & overlays
+│ │ ├── global-components.css # Main layout and widget design systems
+│ │ ├── components/ # Component specific styles
+│ │ ├── layouts/ # Layout specific styles
+│ │ ├── library/ # Library module styles
+│ │ ├── pages/ # Page specific styles
+│ │ └── reader/ # Reader specific styles
│ ├── fonts/ # Local web fonts (including OpenDyslexic)
│ ├── images/ # Assets, avatars, and media
-│ └── js/ # Browser scripts (a11y.js state controller)
+│ └── js/ # Browser scripts
+│ ├── global-a11y.js # Accessibility state controller
+│ ├── assessment-*.js # Assessment and testing logic
+│ ├── curriculum-*.js # Standards and curriculum data
+│ └── mathjax-4.1.3/ # Math equations renderer
│
├── src/ # Core layout modules & reusable code
│ ├── partials/ # HTML/PHP modules
│ │ ├── a11y-settings.php # Accessibility sliding panel interface
│ │ ├── reading-mask.php # Overlay guide container for line-focusing
-│ │ ├── fixed-tools.php # floating action buttons
+│ │ ├── scratchpad.php # Interactive scratchpad widget
+│ │ ├── hero.php # Main hero banner sections
│ │ └── timer.php # Widget timer panel
+│ ├── components/ # Reusable UI component configurations
│ ├── header.php # App shell header (loads stylesheets and scripts)
│ ├── footer.php # App shell footer and dictionary modals
+│ ├── lesson_renderer.php # Dynamic lesson content renderer
+│ ├── resource-modal.php # Modal interface for external resources
│ └── level_template.php # Page template for lessons
│
├── lessons/ # Curriculum activities (Kindergarten - Grade 12)
├── levels/ # Grade dashboard indexes
├── assessment/ # Grade-level tests & grading dashboards
├── library/ # Reader module and text resources
+├── pages/ # Auxiliary views (Settings, About, Dictionary, Profile, etc.)
├── research/ # Documentation & papers on learning design
├── student/ # Student profiles and custom math practice
-├── test/ # QUnit automated test suite
├── index.php # Welcome portal and entry point
-└── settings.php # Full accessibility preferences dashboard
+├── manifest.json # PWA Application Manifest
+└── service-worker.js # PWA Offline capabilities & caching
```
---
## 🏛️ Sections & Their Roles
-* **Accessibility Settings (`/assets/js/a11y.js`, `/settings.php`, `/src/partials/a11y-settings.php`)**
+* **Accessibility Settings (`/assets/js/global-a11y.js`, `/pages/settings.php`, `/src/partials/a11y-settings.php`)**
Consolidates reading masks, text magnification, line-height/word spacing modifiers, color tints (for Irlen syndrome), large cursors, dyslexic-friendly fonts, and a custom spotlight mode.
-* **Curriculum Lessons (`/lessons/` & `/levels/`)**
+* **Curriculum Lessons (`/lessons/`, `/levels/`, & `/assets/js/curriculum-*.js`)**
Houses grade-specific paths (Kindergarten through Grade 12) featuring curriculum tracks built on standards like EngageNY.
-* **Assessments (`/assessment/`)**
+* **Assessments (`/assessment/` & `/assets/js/assessment-*.js`)**
Evaluation tools built for students to demonstrate learning progress. Includes grading panels visible to teachers.
* **Focus Tools (`/src/partials/timer.php`, `/src/partials/scratchpad.php`)**
Widgets such as interactive notes and timers designed to keep students focused.
@@ -72,8 +84,8 @@ The project is structured logically around server-side templating (PHP) and clea
- **Custom Lexile Adjustments & Filters**: Filters books by reading difficulty bands (Easy, Medium, Hard), allowing users to override and edit book Lexile levels client-side via `localStorage`.
- **Auto-injected Chapter Credits**: Automatically pulls and appends source attributions to the bottom of book chapters from a centralized credits registry.
- **Study Notes Integration**: Allows students to select/highlight text inside books and log notes directly to their saved scratchpad.
-* **Client-Side Testing Suite (`/test/`)**
- Ensures code quality and state saving mechanisms work correctly via QUnit assertions.
+* **PWA & Offline Support (`/manifest.json`, `/service-worker.js`)**
+ Enables the platform to be installed as a Progressive Web App (PWA) with caching mechanisms for improved offline functionality and rapid load times.
---