Skip to content

Commit 750f3be

Browse files
VR-RathodVR-Rathod
committed
Make enhance note Kali Linux , Godot and DSA make new System Design page
1 parent d44dbd8 commit 750f3be

7 files changed

Lines changed: 3646 additions & 300 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 332 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,332 @@
1-
# notes **format** Must be same
2-
3-
1. History - How/ Who / Why made this
4-
2. intro - advance / disadvance topics
5-
3. Notes - all kind of note and data share
6-
4. Libs & Framework - share link / docs / make own page(follow same format)
7-
5. require - if some category are missing use this
8-
6. more learn - you can share link on social media like github link , drive (Only trustable link and dont try to pramote social accounts)
9-
10-
This **Rules** are Applied For coding not for **OS**
11-
if You are making notes on OS Use Linux as Ref and make You own way
12-
13-
Note - That Tag name must be on every page you can skip tag if it's not relatable.(like in os lib not useful so you can remove and make require and it's sub category for write )
14-
15-
Thank you developer For your contributions🦾
16-
17-
if you Have any query or question You can contact me. Via mail.
1+
# Contributing to Free Code Notes
2+
3+
Thank you for contributing! This guide defines the **exact format and structure** every page must follow. Consistent structure makes the knowledge base easy to navigate in Logseq and SEO-friendly on the web.
4+
5+
---
6+
7+
## Page Types & Which Format to Use
8+
9+
| Page Type | Format to Follow |
10+
|---|---|
11+
| Programming Language | [Programming Page Format](#programming-page-format) |
12+
| Operating System / Distro | [OS Page Format](#os-page-format) |
13+
| Framework / Library | [Framework Page Format](#frameworklibrary-page-format) |
14+
| Algorithm / Data Structure | [Algorithm Page Format](#algorithmdata-structure-format) |
15+
| Tool / Software | [Tool Page Format](#toolsoftware-format) |
16+
| Concept / Theory | [Concept Page Format](#concepttheory-format) |
17+
18+
---
19+
20+
## File Naming Convention
21+
22+
- Use the **exact display name** as the filename: `Kali Linux.md`, `Cpp.md`, `React js.md`
23+
- Use kebab-case only for multi-word algorithmic pages: `binary-search.md`, `dijkstras-algorithm.md`
24+
- Place all pages inside the `/pages/` directory
25+
- Link pages in `index.md` under the correct section using Logseq `[[Page Name]]` syntax
26+
27+
---
28+
29+
## Frontmatter (Required on Every Page)
30+
31+
Every page **must** start with SEO frontmatter:
32+
33+
```yaml
34+
---
35+
seoTitle: <Page Name> Complete Guide – <Short Description>
36+
description: "Comprehensive <topic> reference covering <key topics>."
37+
keywords: "<keyword1>, <keyword2>, ..., VR-Rathod, Code-Note, code note vr, vr book , <You'r name / your code tags>"
38+
---
39+
```
40+
41+
- `seoTitle` — Keep under 60 characters. Format: `Topic Name – Subtitle`
42+
- `description` — 1-2 sentences, 120-160 characters. Mention key subtopics.
43+
- `keywords` — Comma-separated. Always end with the standard author tags.
44+
45+
---
46+
47+
## Programming Page Format
48+
49+
This is the **primary format**. See `Cpp.md` or `Java.md` as reference implementations.
50+
51+
```
52+
# History
53+
collapsed:: true
54+
- How: (origin story, who created it, when)
55+
- Who: (creator name, organization)
56+
- Why: (motivation, problem it solved)
57+
58+
# Introduction
59+
collapsed:: true
60+
- ## Advantages
61+
- ## Disadvantages
62+
63+
# Basics
64+
collapsed:: true
65+
- ## Hello World & Entry Point
66+
- ## Comments
67+
- ## Variables & Data Types
68+
- ## Operators
69+
- ## Type Casting
70+
- ## User Input / Output
71+
72+
# Control Flow
73+
collapsed:: true
74+
- ## if / else
75+
- ## Switch
76+
- ## Loops (for, while, do-while)
77+
- ## break / continue
78+
79+
# Functions
80+
collapsed:: true
81+
- ## Declaration & Definition
82+
- ## Parameters & Return Types
83+
- ## Recursion
84+
- ## Lambda / Anonymous Functions (if applicable)
85+
86+
# Data Structures
87+
collapsed:: true
88+
- ## Arrays / Lists
89+
- ## Strings
90+
- ## Dictionaries / Maps
91+
- ## Sets
92+
- ## Stacks & Queues
93+
94+
# OOP (if applicable)
95+
collapsed:: true
96+
- ## Classes & Objects
97+
- ## Constructors & Destructors
98+
- ## Inheritance
99+
- ## Polymorphism
100+
- ## Encapsulation & Abstraction
101+
102+
# Advanced Topics
103+
collapsed:: true
104+
- ## Memory Management / Pointers (if applicable)
105+
- ## Concurrency / Threads
106+
- ## Error Handling / Exceptions
107+
- ## File I/O
108+
- ## Generics / Templates (if applicable)
109+
110+
# Standard Library / Built-ins
111+
collapsed:: true
112+
- (language-specific: STL, stdlib, built-in modules)
113+
114+
# Frameworks & Libraries
115+
collapsed:: true
116+
- (link to dedicated pages using [[Page Name]])
117+
118+
# More Learn
119+
- ## Github & Webs (trusted links only)
120+
- ## Master Playlists YouTube (free playlists only)
121+
```
122+
123+
**Rules for code blocks:**
124+
- Always use fenced code blocks with the language tag: ` ```cpp `, ` ```python `, ` ```java `
125+
- Include comments inside code explaining what each line does
126+
- Show both the code AND its output where relevant
127+
- Keep examples minimal but complete — they must run as-is
128+
129+
---
130+
131+
## OS Page Format
132+
133+
See `Kali Linux.md` as the reference implementation.
134+
135+
```
136+
# History
137+
collapsed:: true
138+
- How / Who / Why
139+
140+
# Introduction
141+
collapsed:: true
142+
- ## What is <OS>?
143+
- ## Advantages
144+
- ## Disadvantages
145+
- ## Use Cases
146+
147+
# Installation & Setup
148+
collapsed:: true
149+
- ## System Requirements
150+
- ## Installation Steps
151+
- ## First Boot Configuration
152+
153+
# Kernel & Architecture
154+
collapsed:: true
155+
- ## Kernel Type
156+
- ## Linux File System Hierarchy (for Linux distros)
157+
- ## Boot Process
158+
159+
# Shell & Terminal
160+
collapsed:: true
161+
- ## Shell Types
162+
- ## Essential Commands (with examples)
163+
- ## File Permissions
164+
- ## I/O Redirection & Pipes
165+
- ## Shell Scripting Basics
166+
167+
# User & Group Management
168+
collapsed:: true
169+
- ## Account Types
170+
- ## User Commands
171+
- ## Group Commands
172+
173+
# Package Management
174+
collapsed:: true
175+
- ## Package Manager (apt, yum, pacman, etc.)
176+
- ## Common Commands
177+
178+
# Networking
179+
collapsed:: true
180+
- ## Network Commands
181+
- ## Firewall / iptables
182+
- ## SSH
183+
184+
# [OS-Specific Section]
185+
collapsed:: true
186+
- (e.g., for Kali: Security Tools, Penetration Testing Workflow)
187+
- (e.g., for Ubuntu: Desktop Environment, Snap packages)
188+
189+
# More Learn
190+
- ## Github & Webs
191+
- ## Master Playlists YouTube
192+
```
193+
194+
---
195+
196+
## Framework/Library Page Format
197+
198+
```
199+
# History
200+
collapsed:: true
201+
202+
# Introduction
203+
collapsed:: true
204+
- ## What problem does it solve?
205+
- ## Advantages / Disadvantages
206+
- ## When to use vs alternatives
207+
208+
# Installation & Setup
209+
collapsed:: true
210+
211+
# Core Concepts
212+
collapsed:: true
213+
- (framework-specific fundamentals)
214+
215+
# Common Patterns & Examples
216+
collapsed:: true
217+
218+
# Advanced Usage
219+
collapsed:: true
220+
221+
# More Learn
222+
```
223+
224+
---
225+
226+
## Algorithm/Data Structure Format
227+
228+
```
229+
# What is <Algorithm/DS>?
230+
- Definition, purpose, real-world use cases
231+
232+
# How It Works
233+
collapsed:: true
234+
- Step-by-step explanation with diagram (ASCII art if needed)
235+
236+
# Complexity
237+
collapsed:: true
238+
- Time: O(?) — best / average / worst
239+
- Space: O(?)
240+
241+
# Implementation
242+
collapsed:: true
243+
- ## Python
244+
- ## Java
245+
- ## C++
246+
- (at least 2 languages)
247+
248+
# Variations / Related
249+
collapsed:: true
250+
251+
# More Learn
252+
```
253+
254+
---
255+
256+
## Tool/Software Format
257+
258+
```
259+
# History
260+
collapsed:: true
261+
262+
# Introduction
263+
collapsed:: true
264+
- ## What is it?
265+
- ## Advantages / Disadvantages
266+
267+
# Installation
268+
collapsed:: true
269+
270+
# Core Features & Usage
271+
collapsed:: true
272+
273+
# Common Commands / Workflows
274+
collapsed:: true
275+
276+
# More Learn
277+
```
278+
279+
---
280+
281+
## Concept/Theory Format
282+
283+
```
284+
# What is <Concept>?
285+
- Clear definition
286+
287+
# Why It Matters
288+
collapsed:: true
289+
290+
# How It Works
291+
collapsed:: true
292+
- With examples and diagrams (ASCII art)
293+
294+
# Real-World Applications
295+
collapsed:: true
296+
297+
# Related Concepts
298+
collapsed:: true
299+
- [[Related Page 1]]
300+
- [[Related Page 2]]
301+
302+
# More Learn
303+
```
304+
305+
---
306+
307+
## General Rules (Apply to ALL Pages)
308+
309+
1. **collapsed:: true** — Add to every top-level section except the last `# More Learn` section. This keeps Logseq clean.
310+
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 `### `.
311+
3. **Internal links** — Use `[[Page Name]]` to link to other pages in the knowledge base. Never use relative file paths.
312+
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.
313+
5. **Code blocks** — Always specify the language. Use ```` ```bash ```` for terminal commands, ```` ```python ```` for Python, etc.
314+
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.
315+
7. **Spelling & grammar** — Write in clear English. Use spell-check before submitting.
316+
8. **No duplicate content** — If a topic is already covered in another page, link to it with `[[Page Name]]` instead of repeating it.
317+
9. **SEO keywords** — Always end the `keywords` frontmatter field with `, VR-Rathod, Code-Note, code note vr, vr book`.
318+
10. **File size** — There is no maximum size. Bigger, more detailed pages are better. Depth is valued over brevity.
319+
320+
---
321+
322+
## Submitting Your Contribution
323+
324+
1. Fork the repository
325+
2. Create your page in `/pages/` following the correct format above
326+
3. Add a link to your page in `index.md` under the correct section
327+
4. Submit a Pull Request with a clear title: `Add: <Page Name>` or `Update: <Page Name>`
328+
5. In the PR description, briefly describe what you added or changed
329+
330+
If you have any questions, contact via the repository issues or email listed in the README.
331+
332+
Thank you for contributing! 🦾

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 V Bro
3+
Copyright (c) 2024 VR-Rathod
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

pages/dsa-algo-system-design.md renamed to pages/DSA Algo System Design.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,9 @@ keywords: "DSA, data structures, algorithms, system design, technical interview,
143143
- # Binary systemm
144144
- [[binary]] - every type of binary calculations
145145
-
146+
- # System Design
147+
- For in-depth system design notes covering scalability, load balancing, caching, databases, microservices, CAP theorem, message queues, API design, and real-world case studies, see [[System Design]].
148+
-
146149
- # More Learn
147150
- Explore the following links for valuable resources, communities, and tools to enhance your skills:
148151
-

0 commit comments

Comments
 (0)