Skip to content

README.md

Latest commit

 

History

History
86 lines (56 loc) · 2.58 KB

README.md

File metadata and controls

86 lines (56 loc) · 2.58 KB
Raw

Tech Study Notes

URL: https://tech-study-notes.pages.dev/

Data engineering / software engineering resources (or even personal interests, not directly related to tech). Useful for interviews or just personal knowledge.

Built with Quarkdown, deployed with CloudFlare Pages.

Work in progress: This is an ongoing collection based on my knowledge and interests. Many topics may be intentionally skipped or not yet covered. Contributions are welcome!

ℹ️ About

This repository contains study notes, explanations, and resources for various technical topics including:

  • Computer Science Fundamentals
  • Databases and Data Engineering
  • Software Design and Architecture
  • System Design

🛠️ Getting Started

Prerequisites

  • Quarkdown >= 1.15.1

Installation

# Install Quarkdown (follow instructions at https://quarkdown.com/wiki/installation)
# Clone this repository
git clone https://github.com/yourusername/tech-study-notes.git
cd tech-study-notes

Compiling

# compile
quarkdown c main.qd

# preview
quarkdown c main.qd -p

# live preview while editing
quarkdown c main.qd -p -w

The compiled output will be in the output/ directory.

Note: when working locally, before previewing, run python _scripts/move_images.py, otherwise media is not rendered correctly (at least on my pc)

Publishing new release

  • create and push new branch release/vX.X.X
  • in Cloudflare pages:
    • check deployment preview
    • update production branch
    • re-run deployment

Articles

In the articles section, there's a summary in each file. Use this prompt in an LLM to follow the same style:

Summarize the content in a concise, natural style.

Rules:

* Do NOT say 'the article says' or refer to the text itself — just present the ideas directly
* Keep it relatively short (a few tight paragraphs, not long)
* Use plain, conversational language (not formal, not academic)
* Focus on the key insights and underlying point, not surface details
* Prefer paragraphs over bullet points; only use bullets if absolutely necessary
* Make the flow feel like someone explaining it clearly, not listing notes
* Emphasize cause/effect, tradeoffs, and why things matter
* Avoid fluff, filler, or repetition
* Use "'" (straight apostrophe), never "’"

Output should feel like a sharp, clear explanation from someone who understood the piece well

⚖️ License

This work is licensed under Creative Commons Attribution-ShareAlike 4.0 International.