Computer Science Field Guide Documentation

Welcome to the documentation for the Computer Science Field Guide project. This project’s documentation expands on the general UCCSER documentation, which contains our contributing guide, installation guides, technical stack explanations, style guides, and much more.

This documentation contains information specific to the Computer Science Field Guide 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 for local development

  • Explainations on how the project is setup

  • Quick Starts on how to write and develop for the project

Author Documentation

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

  • Add a new chapter or chapter section

  • Add a translation

Developer Documentation

This documentation is for those who want to contribute to developing the Django system for delivering the Computer Science Field Guide 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

  • Edit the static files (images, CSS, JavaScript, etc) used within the website

  • Add an interactive to the website

  • Contribute to the test suite for checking database models

  • Alter URL routing for views

Table of Contents