Skip to content

Adapt course notes and merge of the first two milestones - #4

Merged
fabnemEPFL merged 3 commits into
mainfrom
feature/adapt-course-notes
Aug 10, 2026
Merged

Adapt course notes and merge of the first two milestones#4
fabnemEPFL merged 3 commits into
mainfrom
feature/adapt-course-notes

Conversation

@fabnemEPFL

Copy link
Copy Markdown
Contributor

This pull request makes several structural and content improvements to the course website and documentation, especially regarding project documentation and milestone instructions. The most significant changes include combining and updating milestone documentation, improving the organization and rendering of project briefs, and adding support for linking PDF slide decks to week pages.

Project Documentation and Milestone Updates:

  • Combined the technical design and reproducible repository requirements into a single milestone (milestone-1-technical-design-and-repository.md), replacing the previous separate milestone documents and updating the rubric and requirements accordingly. The old milestone 1 and 2 files were removed or renamed, and milestone numbers were updated throughout the documentation. [1] [2] [3] [4] [5]
  • Updated the project documentation overview to clarify that each project brief now has its own page, with a summarized overview table shown first.

Project Briefs Rendering and Metadata:

  • Refactored the build process to generate a separate page for each project brief, with a summary table overview. Extracted additional metadata (lead, team size, short description) from project briefs for display in the overview. [1] [2] [3]
  • Updated the build logic to handle new brief document structure and overview generation. [1] [2] [3]

Site Features and Assets:

  • Added support for linking PDF slide decks to week pages via a slides_pdf frontmatter field, and updated the documentation to explain this. Also ensured the slides/ directory is copied to the build output. [1] [2]
  • Added a utility (resource_url) to handle both local and external resource links in the build system. [1] [2]

Styling:

  • Added new CSS styles for .resource-link to improve the appearance of resource links such as slide deck buttons.

Content and Metadata Updates:

  • Updated lecturer and coordinator names on the home page, and removed the "Red Threads" section. [1] [2]

Summary of most important changes:

1. Project Documentation and Milestones

  • Combined milestone 1 and 2 into a single milestone: "Technical Design and Reproducible Repository", updated requirements, rubric, and all references. Old milestone files removed or renamed. [1] [2] [3] [4] [5]
  • Clarified that each project brief now has its own page, with a summary table overview.

2. Project Briefs Build and Metadata

  • Refactored build system to generate individual pages for each project brief and an overview table, extracting and displaying metadata like lead, team size, and description. [1] [2] [3]

3. Site Features

  • Added support for PDF slide deck links in week pages via slides_pdf frontmatter and ensured slides are included in the build. [1] [2]
  • Added resource_url utility for robust resource linking. [1] [2]

4. Styling

  • Introduced .resource-link CSS for improved resource link appearance.

5. Content Updates

  • Updated lecturer and coordinator info, and removed "Red Threads" from the home page. [1] [2]

@fabnemEPFL
fabnemEPFL merged commit f1fbc55 into main Aug 10, 2026
1 check passed
@fabnemEPFL
fabnemEPFL deleted the feature/adapt-course-notes branch August 10, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant