Documentation Guides

← Documentation · Project README · Contributing · Code of Conduct

These guides explain how to read, contribute to, and maintain the 2026–2029 Computer Engineering archive. Use the reading paths below, then consult the tables for a short description of each document.

Start here

Task	Starting point
Read the notes	Use Browse the notes.
Set up the repository	Start with Installation, then use Docker builds for the canonical PDF workflow.
Add a course	Follow Creating a course, then read Writing notes.
Contribute a change	Read Contributing and Building documents.
Report a problem or propose a course	Choose the appropriate issue form.
Change shared LaTeX or tooling	Begin with Architecture and Validation, tests, and CI.
Publish notes	Read the publication workflow. For snapshots, prepare a description using the release template.

Getting started

Prepare a local environment, create a course, and compile its sources.

Guide	Description
Installation	Required tools, validation dependencies, and checks for a working local setup.
Docker builds	The pinned TeX environment, platform-specific setup, cleanup, and troubleshooting.
Creating a course	Generator options, course metadata, initial files, and the first build.
Building documents	Daily commands, build outputs, generated files, and validation before contributing.

Writing notes

Organize course material and keep its prose, notation, and metadata consistent.

Guide	Description
Course structure	Course directories, entry points, sections, assets, and generated-file ownership.
Writing notes	Language, headings, mathematics, code, figures, exercises, references, and review.
Metadata	Course and author fields, academic-year rules, shared defaults, and metadata commands.

LaTeX reference

Use the shared class and its existing interfaces before adding custom typesetting.

Guide	Description
Document class	Class options, loaded components, document lifecycle, numbering, and public commands.

Shared component and font references are indexed by the LaTeX router.

Repository development

Understand the infrastructure, run its checks, and prepare documentation or releases.

Guide	Description
Architecture	Repository layers, ownership boundaries, dependencies, and course compatibility.
Build system	Document discovery, target selection, compilation, README generation, and release packaging.
Validation, tests, and CI	Tool tests, repository checks, CI artifacts, changelogs, release publication, and coverage rules.
Documentation site	Local website builds, PDF readers, public-file boundaries, rendered checks, and Pages deployment.
AI-assisted development	Contributor responsibility, human review, disclosure, and specialized agent guidance.
Release description template	A starting point for a snapshot's scope, included courses, and known limitations.

Project policies

For policies, agent guidance, infrastructure indexes, and documentation assets, return to the project-wide documentation router.