Skip to content

dadezzz/ice-notes

Repository files navigation

ICE Notes

Welcome to my collection of course notes from the ICE (Information, Communications and Electronics) engineering program at the University of Trento. I'm currently in my second year, documenting my academic journey as I progress through various courses.

These notes serve multiple purposes:

  • Personal reference for exam preparation and concept review
  • Knowledge sharing with fellow students
  • Community resource for anyone interested in the topics covered

Project structure

src/
├── content/
│   └── docs/        # Course notes organized by year/semester
│       └── [year]/[semester]/[course]/
│           ├── course.json  # Course metadata
│           └── *.md         # Note content
├── pages/
│   └── index.astro  # Homepage with course listings
├── components/      # Reusable UI components
├── styles/          # Global styles
└── images/          # Images used inside notes, divided by course

Contributing

I welcome contributions! If you find errors, have suggestions for improvements, or would like to new features to the website, please help out.

If you want to upstream your changes:

  1. Request Access:
  2. Make Changes: Fork the repository and create a new branch.
  3. Submit Corrections: Push your changes and open a pull request.

Language policy

Most of the initial courses are taught in Italian, while later courses transition to English. I keep the notes in their original language to preserve technical accuracy and avoid translation errors.

Development environment

For a consistent development experience, this project includes a devcontainer setup. You can open the project in VS Code or Zed to automatically get all required dependencies configured.

Alternatively, follow the manual installation steps below.

Prerequisites

Installation

  1. Clone the repository

    git clone https://git.zarantonello.dev/university/notes
    cd notes
  2. Install dependencies

    pnpm install
  3. Start the development server

    pnpm dev
  4. Open your browser and visit http://localhost:4321 to view the site locally.

Available scripts

Command Description
pnpm dev Start development server with hot reload
pnpm build Build production site
pnpm check Type-check with Astro's built-in checker
pnpm lint:check Run Biome linter
pnpm lint:fix Auto-fix linting issues
pnpm format:check Check code formatting
pnpm format:fix Auto-fix formatting issues
pnpm clean Remove build artifacts

What you can help with

  • Correcting typos and grammatical errors;
  • Improving explanations and adding examples;
  • Adding missing course notes;
  • Suggesting new features or improvements;

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Feel free to share and adapt these notes for non-commercial purposes, provided you give appropriate credit and license your contributions under identical terms.

Links

Contributors