Appendix A#
Requirements Summary#
Priority |
Requirement |
|---|---|
Must Have |
- WYSIWYG editor with Markdown/MyST/Sphinx support |
Should Have |
- WCAG 2.1 compliant UI |
Could Have |
- LaTeX and Python support |
Won’t Have |
- Full GitHub replacement |
Table A.1: All requirements summarized and prioritized using MoSCoW
Requirement |
Description |
Completion Status |
|---|---|---|
Must Have |
- WYSIWYG editor with Markdown/MyST/Sphinx support |
Completed |
- GitHub integration |
Completed |
|
- Git education features (e.g., PAT popup and guidance) |
Completed |
|
- Change preservation |
Completed |
|
- Client-side only implementation |
Completed |
|
- Jupyter Book 1.x compliance |
Completed |
|
Should Have |
- WCAG 2.1 compliant UI (keyboard nav, color palette, etc.) |
Not Implemented |
- Context-aware editing tools (toolbar adapts to block type) |
Not Implemented |
|
- Exercise block templates |
Not Implemented |
|
- Full book authoring |
Not Implemented |
|
Could Have |
- LaTeX (math expressions, not full syntax) rendering and editing |
Completed |
- Python rendering and editing |
Not implemented |
|
- Real-time collaboration |
Not Implemented |
|
- GitLab integration |
Not Implemented |
Table A.2: Requirement Completion Overview