Repository Structure¶

This repository is organized to clearly separate documentation, source code, and project phases.

The structure supports reproducibility, academic clarity, and long-term maintainability.

Root Directory¶

mkdocs.yml

Configuration file for the MkDocs documentation site, including theme settings, navigation structure, and plugins.
.github/workflows/

GitHub Actions workflows for automated build and deployment of the documentation site.

docs/index.md

Homepage of the documentation site.
docs/project/

Core project information including overview, requirements, team details, and repository structure.
docs/phase1/

Phase I content: setup, build instructions, experiments, results, and report.
docs/phase2/

Phase II content: planning, work log, results, and final reporting.
docs/reference/

Supporting material including common commands and glossary definitions.
docs/styles/

Custom CSS styling used to define layout, theme adjustments, and visual consistency.

program.c

Instructor-provided C program used for experimentation and performance evaluation.

Separation of Concerns

Source code remains independent from documentation and reporting materials.
Phase Isolation

Phase I and Phase II are organized independently to clearly distinguish experimental stages.
Academic Clarity

Setup, execution, analysis, and reporting are documented in structured sections.
Maintainability

The modular structure improves readability and supports long-term extension of the project.