docs: Update all root-level documentation for new folder structure

This commit is contained in:
John Loper II
2026-04-20 17:17:42 -04:00
parent 501e456f7b
commit 52ece3a2de
3 changed files with 46 additions and 24 deletions
+5 -3
View File
@@ -4,8 +4,9 @@
### Overview ### Overview
- **Date Range**: [Start Date] - [End Date] - **Date Range**: [Start Date] - [End Date]
- **Grade Level**: [K-2 / 3-5 / 6-8 / 9-12 / Adult] - **Grade Level**: [Elementary (K-6) / Middle-High-School (6-12)]
- **Theme/Focus**: [Optional - e.g., Science, Literature, Academic] - **Folder**: [Elementary-School/ / Middle-High-School/]
- **Theme/Focus**: [Optional - e.g., Science, Literature, Academic, Character Traits]
### Vocabulary List ### Vocabulary List
@@ -15,7 +16,8 @@
### Progress ### Progress
- [ ] Word list generated - [ ] Word list generated
- [ ] Words added to system - [ ] README.md created for the week
- [ ] Words added to WORD_LIST.md (Middle-High-School only)
- [ ] Study materials created - [ ] Study materials created
- [ ] Practice exercises completed - [ ] Practice exercises completed
- [ ] Weekly review completed - [ ] Weekly review completed
+19 -13
View File
@@ -1,7 +1,7 @@
# Weekly Vocabulary Project # Weekly Vocabulary Project
## Overview ## Overview
A systematic approach to building vocabulary through weekly word lists, organized by grade level and difficulty. This project generates fresh vocabulary each week, building on previous weeks' words. A systematic approach to building vocabulary through weekly word lists, organized by grade level and difficulty. This project generates fresh vocabulary each week for both elementary and middle-high school students, building on previous weeks' words.
## Project Structure ## Project Structure
``` ```
@@ -10,26 +10,32 @@ Weekly-Vocabulary/
├── ISSUE_TEMPLATE.md # Weekly vocabulary tracking template ├── ISSUE_TEMPLATE.md # Weekly vocabulary tracking template
├── progress.md # Current week status ├── progress.md # Current week status
├── Elementary-School/ # Vocabulary for Grades K-6 ├── Elementary-School/ # Vocabulary for Grades K-6
│ ├── README.md │ ├── README.md # Elementary folder guide
│ └── WEEK-YYYY-MM-DD/ │ └── WEEK-YYYY-MM-DD/ # Individual week folders
│ ├── README.md # Week overview with definitions
│ └── words.md # Simple word list (optional)
└── Middle-High-School/ # Vocabulary for Grades 6-12 └── Middle-High-School/ # Vocabulary for Grades 6-12
├── README.md ├── README.md # Middle-High folder guide
── WEEK-YYYY-MM-DD/ ── WORD_LIST.md # Master word list (all weeks)
├── README.md # Week overview └── WEEK-YYYY-MM-DD/ # Individual week folders
── WORD_LIST.md # Master list for the grade level ── README.md # Week overview with definitions
└── progress.md # Weekly progress
``` ```
## Organization ## Organization
- **Grade Levels**: Words organized by difficulty (K-2, 3-5, 6-8, 9-12, Adult) - **Elementary-School**: Simple, kid-friendly words with clear definitions and relatable example sentences
- **Middle-High-School**: Advanced vocabulary for grades 6-12, including academic, literary, and standardized test preparation words
- **Weekly Rotation**: New words each week based on previous weeks' lists - **Weekly Rotation**: New words each week based on previous weeks' lists
- **Progressive Learning**: Words build on previous vocabulary - **Progressive Learning**: Words build on previous vocabulary
## How to Use ## How to Use
1. Create new week folder with current date 1. Determine the appropriate grade level (Elementary or Middle-High-School)
2. Generate 10-20 new vocabulary words (not in previous weeks) 2. Create new week folder with current date in the appropriate folder
3. Include word, definition, part of speech, example sentence 3. Generate 10 new vocabulary words (not in previous weeks or master list)
4. Update progress.md with completion status 4. Include word, definition, part of speech, and example sentence
5. Commit and push to Gitea 5. For Middle-High-School: Update WORD_LIST.md with the new week's entries
6. Update progress.md with completion status
7. Commit and push to Gitea
## Repository ## Repository
**Gitea**: https://gitea.loperfamily.com/Sage_Software/Weekly-Vocabulary **Gitea**: https://gitea.loperfamily.com/Sage_Software/Weekly-Vocabulary
+22 -8
View File
@@ -1,25 +1,39 @@
# Weekly-Vocabulary Progress # Weekly-Vocabulary Progress
## Current Status: INITIALIZED ## Current Status: ORGANIZED
### Project Created: 2026-03-30 ### Project Created: 2026-03-30
### Reorganized: 2026-04-20
### Structure: ### Structure:
- ✅ README.md - Project documentation - ✅ README.md - Project documentation
- ✅ ISSUE_TEMPLATE.md - Weekly vocabulary tracking template - ✅ ISSUE_TEMPLATE.md - Weekly vocabulary tracking template
- 🔄 progress.md - This file - progress.md - This file
- ✅ Elementary-School/ - Folder for elementary vocabulary (K-6)
- ✅ README.md - Folder guide for elementary lists
- 📁 WEEK-YYYY-MM-DD/ - Individual week folders (coming soon)
- ✅ Middle-High-School/ - Folder for middle & high school vocabulary (6-12)
- ✅ README.md - Folder guide for middle-high lists
- ✅ WORD_LIST.md - Master word list (all weeks)
- 📁 WEEK-YYYY-MM-DD/ - Individual week folders
- ✅ WEEK-2026-03-16 through WEEK-2026-04-27 (8 weeks of existing content)
### Next Steps: ### Completed:
1. Review the ISSUE_TEMPLATE.md for weekly tracking - [x] Created Elementary-School folder with README
2. Create WEEK-YYYY-MM-DD folders for each week's vocabulary - [x] Renamed High-School to Middle-High-School
3. Generate word lists based on previous weeks' words - [x] Moved all existing week folders to Middle-High-School/
4. Commit and push to Gitea after each week - [x] Updated WORD_LIST.md in chronological order
- [x] Updated README.md, ISSUE_TEMPLATE.md, progress.md
### Gitea Repository: ### Gitea Repository:
https://gitea.loperfamily.com/Sage_Software/Weekly-Vocabulary https://gitea.loperfamily.com/Sage_Software/Weekly-Vocabulary
### Weekly Process: ### Weekly Process:
- **Monday**: Generate new word list (10-20 words) - **Monday**: Generate new word list (10 words per grade level)
- **Tuesday-Thursday**: Study and practice - **Tuesday-Thursday**: Study and practice
- **Friday**: Review and assessment - **Friday**: Review and assessment
- **Saturday-Sunday**: Rest/review - **Saturday-Sunday**: Rest/review
### Current Weeks:
- **Elementary**: No weeks created yet
- **Middle-High-School**: Weeks 2026-03-16, 03-23, 03-30, 04-13, 04-20, 04-27 (6 weeks)