Vegman · documentation
Vegman Documentation
Research, requirements and design notes for the school-timetabling product. Israel first, generalize later.
Documents
Research and market brief What problem we are solving in exact computer-science terms, which solver to build on, how the Israeli and global markets work, the research frontier and AI, and Vegman's inputs from Mevo Hagalil. English and Hebrew, glossary tooltips, search. תקציר מחקר ושוק: הבעיה, הפותר, השוק בישראל ובעולם, חזית המחקר ו-AI, והקלט של ווגמן ממבוא הגליל. Mevo Hagalil requirements, v0.1 The pilot school's timetable rules with IDs (R, S, Q, N), translations, interpretations, evidence from the achieved timetable, and open questions. Standalone copy of section 6 of the brief. דרישות מערכת השעות של מבוא הגליל, עם מזהים, פרשנות, עדויות ושאלות פתוחות. Mevo Hagalil requirements table The same items as a sortable, filterable table: ID, category, title, statement, Hebrew original, kind, scope, status, priority, evidence, related IDs, source. Column toggles and CSV export. טבלת הדרישות: ניתנת למיון ולסינון, עם ייצוא CSV.Design
Domain model proposal How the product models a school and everything it must timetable: organisation, people, curriculum, events, constraints and timetable versions. Entity diagram, entity catalogue, and the mapping from Vegman's requirements to model elements. הצעת מודל התחום: ישויות, קשרים, ומיפוי הדרישות למודל. API and data contract, v0.1 The single agreement between the engine track and the experience track: JSON shapes for every domain object, the constraint types with their parameters, and the HTTP endpoints. Both tracks build against it. חוזה ה-API והנתונים: צורות ה-JSON, סוגי האילוצים ונקודות הקצה שהצד השרתי וחוויית המשתמש בונים מולן. Solver strategy: living with NP-completeness How the engine makes the problem tractable without pretending it is easy: fix what is decided, decompose, let CP-SAT propagate and learn, run anytime, warm-start and repair. With measured numbers from Mevo Hagalil's real timetable. אסטרטגיית הפותר: איך הופכים בעיה NP-שלמה לפתירה בפועל, עם מדידות על המערכת האמיתית של מבוא הגליל. Personas and flows Who uses the product and how: the timetable coordinator as primary persona, nine journeys from import to mid-year change, information architecture, the RTL and bilingual approach, what explainability looks like on screen, and a screen inventory with build status. פרסונות ותהליכים: מי משתמש במוצר ואיך, מסעות המשתמש, ארכיטקטורת המידע ומלאי המסכים. Rule catalogue The 22 rules Mevo Hagalil applies, and the general parameterised rule types they instantiate, grouped in six families with parameters, status (live or planned) and how a new school selects and configures them. קטלוג הכללים: 22 הכללים של מבוא הגליל, וסוגי הכללים הכלליים עם פרמטרים שבית ספר אחר בוחר ומגדיר.Applications
Timetable application prototype The working UI prototype against a stubbed backend: dashboard, timetable grid in class, grade and teacher views, violations panel, staff and availability, constraints checklist, solve dialog, drag-to-swap and local repair. Hebrew RTL by default. אב-טיפוס של יישום מערכת השעות מול שרת מדומה. Tutorial video A seven-minute screen recording of the prototype with narration and captions, in nine chapters: the product and its coordinator, the dashboard, the grid, violations and explainability, the rules, staff and availability, solve, repair and publish, and what comes next. English and Hebrew cuts, clickable chapters, the script. סרטון הדרכה: הקלטת מסך של אב-הטיפוס עם קריינות וכתוביות, בעברית ובאנגלית, עם פרקים ותסריט. Back-office The question exchange with Mevo Hagalil: every question with its filed and live answers, the questionnaire link for Vegman, and exports. Password protected. משרד אחורי: חילופי השאלות והתשובות עם מבוא הגליל.How this site is maintained
Markdown files under apps/docs/content/ are the source of truth for generated sections. Run npm run build in apps/docs to regenerate, and npm run dev to serve the site at localhost:4173. Reference data that must not be published lives outside the site, under data/.