Skip to content

Fab26 Workshop Documentation

Welcome to the Fab26 Workshop Documentation mockup.

This repository is for collaboratively documenting workshops during Fab26 using Fab Cloud and MkDocs Material.

The goal is not to require documentation for every workshop, but to provide a shared place where presenters and participants can contribute workshop notes, photos, slides, code, and other resources if they choose.

Fab26 event page

Parallel to Fab26 in Boston there is also a regional FabX event happening at Bottrop.

Regional Fab26 - Bottrop

header

Features

  • Workshop documentation organized by day
  • Standardized workshop template
  • GitLab repository integration
  • Edit page directly from the website
  • Automatic author attribution
  • Creation and last update dates

Repository structure

day1/
└── workshop-name/
    ├── workshop-name.md
    └── assets/
        ├── img/
        └── ...
...
day2/
...
  • day1/: Day of the workshop.
  • workshop-name/: Directory for a specific workshop.
  • wordshop-name.md: Markdown file used to document the workshop.
  • assets: Supporting files such as slides, source files, PDFs, and other resources.
    • img: Images used in the documentation.

Contributing

To document a workshop:

  1. Copy the workshop_template into the appropriate day.
  2. Rename the folder and Markdown file.
  3. Add workshop notes, images, slides, code, and other resources.
  4. Commit and push your changes if working locally.