Engineering Notes & Knowledge Base

A curated personal repository of engineering notes, reference implementations, library recipes, competitive programming solutions, and machine learning experiments.

📖 Browse the complete categorized directory in INDEX.md

---

🧭 Topic Categories

The repository is organized across 8 primary domains:

Category	Description	Key Topics / Highlights
🧠 Artificial Intelligence & ML	LLMs, deep learning, RL, speech & vision	LLM/ (RAG, fine-tuning, Ollama), jax/ (Flax, JIT, VAE), RL/ (DQN, DDPG), Real-ESRGAN/, tts/, whisper/, ocr/, bpe/
⚡ Algorithms & CP	Algorithms & competitive programming problem sets	algorithm/ (50+ C++/Rust implementations), leetcode/ (24 patterns & numbered problems), codeforces/, atcoder/, cses/, advent-of-code/
💻 C++ Ecosystem	80+ C++ libraries with working CMake recipes	cpp/ spanning AI runtimes (llama.cpp, whisper.cpp, onnx, faiss, pytorch), graphics (SDL3, raylib, imgui), networking (grpc, curl, libuv), storage (redis, rocksdb, sqlite3), formats & compression
📱 Mobile, Embedded & IoT	Android native & embedded microcontrollers	android/ (CameraX, Compose, Vulkan, on-device ML), esp/ (ESP32 CSI Wi-Fi sensing), esp32_linux.md, esphome/, pico/ (RP2040), robotics/
🛠️ Systems & DevOps	OS, kernel, networking & deployment	linux/ (custom kernel & minimal distro), os/ (x86 bootloader asm), kubernetes/, elasticsearch/, prometheus/, cloudflared/, ngrok/, nginx/
🔒 Security & Cryptography	Code auditing, IaC security & PKI	security/ (Semgrep, KICS, Dependency-Check), crypto/ (RSA), ssl.md (OpenSSL certificates)
🎨 Web & Multimedia	Audio/video processing, graphics & UI	ffmpeg.md, flutter/ (custom shaders), opengl/ (N-body simulation), pdf/ (Stirling-PDF), css_tricks.md, html/
🧬 Healthcare & Bioinformatics	Medical standards & computational biology	bioinformatics/ (sequence analysis), fhir/ (HL7 FHIR JPA server), loinc/ (terminology API)

---

🗂️ Navigating the Notes

• Topic Index: Open INDEX.md for a categorized table of contents with descriptions, file counts, and direct links to sub-topics and library recipes.
• C++ Showcase: Explore cpp/ to view working build recipes and sample code for 80+ modern C++ libraries.
• Algorithms: Browse algorithm/ for self-contained algorithms in C++ and Rust (graphs, segment trees, FFT, strings, geometry, math).
• Machine Learning: Check LLM/ and jax/ for Jupyter notebooks covering RAG, local chatbot deployment, fine-tuning, and functional deep learning.

---

🔄 Maintaining & Updating INDEX.md

An automated script is provided to scan the repository, calculate statistics, and keep INDEX.md synchronized with new notes and directories.

Running the Script

# Update INDEX.md from repository root
python scripts/update_index.py
# or via the root shortcut:
python update_index.py

Checking for Consistency (CI / Pre-Commit)

python scripts/update_index.py --check

The --check flag verifies whether INDEX.md is strictly up to date and exits with code 0 on success or code 1 if regeneration is required.

Options

usage: update_index.py [-h] [--repo-dir REPO_DIR] [--output OUTPUT] [--check] [--dry-run] [--quiet]

options:
  -h, --help            Show this help message and exit
  --repo-dir REPO_DIR   Root directory of the repository (default: auto-detected)
  --output OUTPUT, -o   Path to output file (default: INDEX.md at repo root)
  --check               Check if INDEX.md is up to date without modifying
  --dry-run             Print generated markdown to stdout without writing
  --quiet, -q           Suppress non-error output

---

🛠️ Environment & Tooling

• Python: >= 3.12 (managed via uv or standard python3)
• Dependencies: configured in pyproject.toml