Skip to content

Commit fc9f491

Browse files
committed
Started DSA Better In depth Notes, update Contribution Guide , and more notes For Game dev
1 parent 683fe36 commit fc9f491

17 files changed

Lines changed: 3105 additions & 285 deletions

CONTRIBUTING.md

Lines changed: 81 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -240,30 +240,45 @@ See `Kali Linux.md` as the reference implementation.
240240
241241
## Algorithm/Data Structure Format
242242
243+
See `Binary Search.md` or `` as reference implementations.
244+
243245
```
244-
# What is <Algorithm/DS>?
245-
- Definition, purpose, real-world use cases
246+
# Explanation
247+
- Clear definition, purpose, real-world use cases
248+
- ## Real-World Analogy (optional but recommended)
249+
- ## Why <Algorithm>? (optional — key insight or motivation)
246250

247251
# How It Works
248252
collapsed:: true
249-
- Step-by-step explanation with diagram (ASCII art if needed)
253+
- ## Step-by-Step Process (ASCII art / pseudocode block)
254+
- ## Visual Walkthrough (traced example with sample data)
250255

251-
# Complexity
256+
# Time & Space Complexity
252257
collapsed:: true
253-
- Time: O(?) — best / average / worst
254-
- Space: O(?)
258+
- Plain text table: Best / Average / Worst / Space
259+
- Comparison to alternatives if relevant
255260

256261
# Implementation
257262
collapsed:: true
258-
- ## Python
259-
- ## Java
260-
- ## C++
261-
- (at least 2 languages)
263+
- Use :::code-tabs for multi-language tab view (Python, C++, JS, Java, C)
264+
- Use logseq default code block for single-language focused snippet
265+
- At minimum: Python + one systems language (C++ or C)
262266

263-
# Variations / Related
267+
# Recursive Variant (optional)
264268
collapsed:: true
269+
- Use logseq default code block for the recursive version
265270

266-
# More Learn
271+
# When to Use
272+
collapsed:: true
273+
- ## Use <Algorithm> When: (bullet list of ✅ good cases)
274+
- ## Avoid When: (bullet list of ❌ bad cases)
275+
276+
# Variations / Related (optional)
277+
collapsed:: true
278+
- Use logseq default code block for each variant snippet
279+
280+
# Key Takeaways
281+
- 4–7 concise bullets summarizing the most important points
267282
```
268283
269284
---
@@ -319,18 +334,70 @@ See `Kali Linux.md` as the reference implementation.
319334
320335
---
321336
337+
## Code Block Formats
338+
339+
This project uses three code block styles. Use the right one for the right context:
340+
341+
### 1. Plain Fenced Block — ```` ```language ````
342+
Use for a **single standalone snippet** inside a regular bullet.
343+
```python
344+
def example():
345+
pass
346+
```
347+
348+
### 2. `:::code-note` — Single-Language Focus Block
349+
Use for a **featured snippet** that deserves visual emphasis — a clean, dedicated display for one language.
350+
Perfect for: recursive variants, utility helpers, built-in usage examples.
351+
```
352+
:::code-note
353+
354+
```python
355+
def binary_search(arr, target):
356+
...
357+
```
358+
359+
:::
360+
```
361+
362+
### 3. `:::code-tabs` — Multi-Language Tab View
363+
Use when showing the **same algorithm in multiple languages** side by side as switchable tabs.
364+
Perfect for: main implementation sections where you want Python, C++, JS, Java, C all available.
365+
```
366+
:::code-tabs
367+
368+
```python
369+
# Python implementation
370+
```
371+
372+
```cpp
373+
// C++ implementation
374+
```
375+
376+
```javascript
377+
// JavaScript implementation
378+
```
379+
380+
:::
381+
```
382+
383+
> **Rule:** Always use `:::code-tabs` for multi-language implementations, `:::code-note` for single highlighted snippets, and plain fenced blocks for inline examples within bullet text.
384+
385+
---
386+
322387
## General Rules (Apply to ALL Pages)
323388
324-
1. **collapsed:: true** — Add to every top-level section except the last `# More Learn` section. This keeps Logseq clean.
389+
1. **collapsed:: true** — Add to every top-level section except the first (`# Explanation`) and last (`# Key Takeaways`). This keeps Logseq clean.
325390
2. **Logseq bullet syntax** — All content must use `- ` (dash + space, by default will apply if you are using Logseq) bullet format. Headings inside bullets use `## ` or `### `.
326391
3. **Internal links** — Use `[[Page Name]]` to link to other pages in the knowledge base. Never use relative file paths.
327392
4. **No broken links** — Only link to pages that actually exist in `/pages/`. If the page doesn't exist yet, create it or leave plain text.
328-
5. **Code blocks** — Always specify the language. Use ```` ```bash ```` for terminal commands, ```` ```python ```` for Python, etc.
393+
5. **Code blocks** — Always specify the language tag. Use ```` ```bash ```` for terminal commands, ```` ```python ```` for Python, etc. See [Code Block Formats](#code-block-formats) for `:::code-note` and `:::code-tabs`.
329394
6. **No promotion** — The `# More Learn` section only accepts links to trusted public resources: GitHub repos, official docs, free YouTube playlists. No personal social media promotion.
330395
7. **Spelling & grammar** — Write in clear English. Use spell-check before submitting.
331396
8. **No duplicate content** — If a topic is already covered in another page, link to it with `[[Page Name]]` instead of repeating it.
332397
9. **SEO keywords** — Always end the `keywords` frontmatter field with `, VR-Rathod, Code-Note, code note vr, vr book`.
333398
10. **File size** — There is no maximum size. Bigger, more detailed pages are better. Depth is valued over brevity.
399+
11. **Code comments** — All code snippets must have inline comments explaining key lines. Show output where relevant.
400+
12. **Overflow prevention** — In C/C++/Java, always use `mid = low + (high - low) / 2` instead of `(low + high) / 2` when doing binary search to prevent integer overflow. Document this in your code.
334401
335402
---
336403

funding.json

Lines changed: 0 additions & 19 deletions
This file was deleted.

pages/About.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: About
3+
description: "About Free Code Notes — a free, comprehensive programming knowledge base built by VR-Rathod for developers, students, and tech enthusiasts."
4+
cssclasses:
5+
- legal-page
6+
noindex: true
7+
---
8+
9+
- # About Free Code Notes
10+
11+
**Free Code Notes** is a free, open, and ever-growing programming knowledge base — built by a developer, for developers.
12+
13+
---
14+
- ## What is This?
15+
16+
This site is a personal programming reference book made public for everyone to benefit from. It covers:
17+
- 🌐 **Programming Languages** — Python, C++, Java, Rust, Go, TypeScript, and many more
18+
- 🧠 **DSA & Algorithms** — Sorting, searching, graph algorithms, dynamic programming
19+
- 🎮 **Game Development** — Godot, Unity, Unreal Engine, graphics pipelines, Vulkan, DirectX
20+
- 🔐 **Cybersecurity** — Ethical hacking, network security, OWASP, penetration testing
21+
- 🖥️ **Operating Systems** — Linux distros, Windows internals, kernel concepts
22+
- 🤖 **Data Science & ML** — Machine learning fundamentals, data pipelines, Python libraries
23+
- ☁️ **DevOps** — Docker, Kubernetes, CI/CD, cloud platforms
24+
- 🎨 **Design Tools** — Blender, Figma, game audio, and creative software
25+
26+
---
27+
- ## Why I Built This
28+
29+
As a developer constantly learning new technologies, I found myself keeping notes scattered across multiple places — Logseq, Notion, random text files. I wanted a single, beautiful, searchable reference I could access from anywhere.
30+
31+
So I built **Free Code Notes**: a Quartz-powered digital garden that converts my Logseq notes into a fast, searchable website — and made it free for everyone.
32+
33+
---
34+
- ## Features
35+
- 🔖 **Smart Bookmarks** — Bookmark any page or specific heading. Sign in with GitHub to sync bookmarks across all your devices via the cloud.
36+
- 🔍 **Full-Text Search** — Instantly find anything across 300+ notes.
37+
- 🌙 **Dark Mode** — Easy on the eyes, day and night.
38+
- 💬 **Comments** — Discuss topics using Giscus (powered by GitHub Discussions).
39+
-**Fast** — Statically generated with zero JavaScript required for reading.
40+
41+
---
42+
- ## The Builder
43+
44+
Hi, I'm **VR-Rathod** — a passionate developer and learner who loves building tools that make knowledge accessible.
45+
- 🐙 GitHub: [github.com/VR-Rathod](https://github.com/VR-Rathod)
46+
47+
---
48+
- ## Legal
49+
- [[privacy-policy|Privacy Policy]]
50+
- [[terms-of-service|Terms of Service]]
51+
52+
---
53+
54+
> *"The best way to learn is to teach."*
55+
>
56+
> This site is my way of teaching — and learning — in public. I hope it helps you on your journey! 🚀

0 commit comments

Comments
 (0)