Activity 1
Building a Documentation Website with MkDocs Material
Documenting Design & Fabrication Processes
Objective
Enable students to document modeling and fabrication work professionally using a static documentation website.
Task Description
Students must create a documentation website using MkDocs with the Material theme to document their digital modeling and fabrication learning process.
The website should document:
- Course understanding
- Design decisions
- Modeling workflow
- Fabrication considerations
- Reflections and outcomes
Required Pages
At minimum, the site must include:
- Home – course overview & student introduction
- Digital Modeling – modeling approach, screenshots, files
- Fabrication Logic – machines, materials, constraints
- Prototyping & Iteration – tests, failures, improvements
- Reflection – lessons learned & critical analysis
Technical Requirements
- MkDocs Material theme
- Markdown-based content
- Images, diagrams, and captions
- Clear navigation structure
Deliverables
- Local MkDocs project folder
- Live preview of the documentation site
Learning Outcome
Students learn that documentation is part of the design process, not an afterthought.
Activity 2
Publishing Documentation via GitHub Pages
From Local Project to Public Knowledge
Objective
Teach students how to publish and share technical documentation using GitHub and GitHub Pages.
Task Description
Students must upload their MkDocs documentation project to their GitHub account and publish it as a GitHub Pages website.
Steps Students Must Complete
- Create a GitHub repository for the documentation
- Push the MkDocs project files to GitHub
- Configure:
- Repository structure
- GitHub Pages settings
- Deploy the site so it is accessible via a public URL
Submission Requirements
- GitHub repository link
- Live GitHub Pages URL
- Screenshot of deployed website
Learning Outcome
Students gain skills in version control, open documentation, and reproducible workflows.
Activity 3
Documentation Quality & Peer Review
Evaluating Clarity, Reproducibility & Design Thinking
Objective
Develop critical evaluation skills by reviewing technical documentation quality.
Task Description
Students perform a peer review of another student's documentation website.
Each student must evaluate:
- Clarity of explanations
- Quality of visuals and diagrams
- Logical structure and navigation
- Ability to reproduce the work from documentation alone
Peer Review Criteria
- Is the process understandable?
- Are modeling decisions justified?
- Are fabrication constraints clearly explained?
- Is the documentation professional and readable?
Deliverables
- Peer review report (1–2 pages)
- Constructive written feedback
- Suggested improvements
Learning Outcome
Students understand that good documentation enables knowledge transfer and collaboration.