How txt/se25fall works
Project type and purpose
• This is not a full-stack app or microservice landscape, but a static documentation site and course asset repository for “CSC510: Software Engineering.”
• It holds lecture notes, project prompts, reviews, a syllabus, PDF outputs, and shell config snippets—all organized under a Markdown-centric docs folder, built via a Makefile.
File structure
• Top-level:
• README.md – landing page with badges, course overview, and links to external resources (Moodle, Google Sheets, Discord, Panopto).
• LICENSE.md, .gitignore – standard repo housekeeping.
• docs/ – contains all Markdown content, subfolders for lectures, projects, reviews, a Makefile, and a generated PDF/ folder.
• sh/ – local shell/dotfile snippets (dotbash.rc, init.lua) used by the instructor or contributors.
• Patterns: single repo holding both source content (Markdown) and build scripts (docs/Makefile). Output artifacts land under docs/pdf.
README for additional insights
• README anchors the system’s purpose: organize weekly lectures, assignment deliverables, and review materials.
• No built-in server code is present—implies a static site generator (or raw Markdown served via GitHub Pages) plus PDF generation via Make/pandoc.
Detail
• Every folder of docs (lectures, projects, reviews) as sub-nodes or annotate “docs/lectures,” “docs/projects,” etc., to show content organization.
• Sh/ dotfiles area to indicate developer environment support.
• Don’t over-abstract: show both PDF and HTML branches if both are produced.