Welcome to CS Unplugged

Welcome to the documentation for the CS Unplugged project. The documentation is split into the following sections:


Getting Started Documentation

This documentation contains:

  • Our expectations of your contributions to the project
  • Steps to install the project on your system
  • Explainations on how the project is setup
  • Details on basic commands to use the system

Author Documentation

This documentation is for those who want to help write content for the CS Unplugged project, specifically text content. This is the documentation to read if you want to do any of the following (or similar):

  • Add a new topic
  • Clear up instructions on a lesson
  • Add a language implementation for a programming challenge
  • Add a translation

Developer Documentation

This documentation is for those who want to contribute to developing the Django system for delivering the CS Unplugged content. This is the documentation to read if you want to do any of the following (or similar):

  • Edit HTML templates used to render webpages
  • Edit CSS used for styling the website
  • Add a generatable PDF resource
  • Contribute to test suite for checking database models
  • Alter URL routing for views

Table of Contents