Skip to content

Commit f507464

Browse files
shadil-rayyanshadil-rayyan
committed
feat : added nav,logo,favicon as well
1 parent bf43ed5 commit f507464

File tree

8 files changed

+304
-1
lines changed

8 files changed

+304
-1
lines changed

‎README.md‎

Lines changed: 155 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,155 @@
1-
# cse-student-starter-guide
1+
2+
# 🚀 CSE Starter Guide Kit
3+
4+
![License](https://img.shields.io/badge/License-MIT-blue)
5+
![Contributors](https://img.shields.io/badge/Contributors-Open-brightgreen)
6+
![GitHub stars](https://img.shields.io/github/stars/shadil-rayyan/cse-student-starter-guide)
7+
![GitHub forks](https://img.shields.io/github/forks/shadil-rayyan/cse-student-starter-guide)
8+
![GitHub last commit](https://img.shields.io/github/last-commit/shadil-rayyan/cse-student-starter-guide)
9+
10+
**CSE Starter Guide Kit** is a curated, beginner-friendly guide and resources kit for computer science students to learn core concepts, domains, tools, and career essentials.
11+
12+
---
13+
14+
## 🎯 Table of Contents
15+
- [🚀 CSE Starter Guide Kit](#-cse-starter-guide-kit)
16+
- [🎯 Table of Contents](#-table-of-contents)
17+
- [📝 About](#-about)
18+
- [✨ Features](#-features)
19+
- [🚀 Getting Started](#-getting-started)
20+
- [📂 Folder Structure](#-folder-structure)
21+
- [🖼 Screenshots](#-screenshots)
22+
- [🎬 Demo](#-demo)
23+
- [🤝 Contributing](#-contributing)
24+
- [📚 Resources](#-resources)
25+
- [📜 License](#-license)
26+
- [📬 Contact](#-contact)
27+
28+
---
29+
30+
## 📝 About
31+
32+
This guide is built for **college-level CSE students** who want a structured roadmap from fundamentals to domain exploration, daily reading habits, and career preparation.
33+
It covers:
34+
35+
- Programming languages & tools
36+
- Linux, Git, GitHub, and productivity tips
37+
- Domains like AI, Web Development, Game Development, Embedded Systems
38+
- College life hacks, hackathons, placements, scholarships
39+
- Open-source participation & social media guidance
40+
41+
---
42+
43+
## ✨ Features
44+
45+
- Beginner-friendly & structured for easy navigation
46+
- Multi-domain coverage (Android, AI, Web, Blockchain, DevOps, etc.)
47+
- Career guidance (resume, portfolio, hackathons)
48+
- Open-source programs and contribution guides
49+
- Cheat sheets, resources, and FAQs
50+
- Offline-ready MkDocs website
51+
52+
---
53+
54+
## 🚀 Getting Started
55+
56+
**1. Clone the repository**
57+
```bash
58+
git clone https://github.com/shadil-rayyan/cse-student-starter-guide.git
59+
cd cse-student-starter-guide
60+
````
61+
62+
**2. Install dependencies**
63+
64+
```bash
65+
pip install mkdocs-material mkdocs-minify-plugin mkdocs-awesome-pages-plugin mkdocs-macros-plugin mkdocs-codeinclude-plugin
66+
```
67+
68+
**3. Serve locally**
69+
70+
```bash
71+
mkdocs serve
72+
```
73+
74+
**4. Build for GitHub Pages**
75+
76+
```bash
77+
mkdocs build
78+
mkdocs gh-deploy
79+
```
80+
81+
---
82+
83+
## 📂 Folder Structure
84+
85+
```
86+
├── assets
87+
│ └── logo.png
88+
├── college
89+
├── core
90+
├── daily-reading
91+
├── domain
92+
├── job
93+
├── open-source
94+
├── social-media
95+
├── index.md
96+
├── about.md
97+
├── resources.md
98+
├── cheatsheet.md
99+
├── faq.md
100+
└── contributing.md
101+
```
102+
103+
---
104+
105+
## 🖼 Screenshots
106+
107+
**Home Page**
108+
109+
![Home](images/home.png)
110+
111+
**Domain Section**
112+
113+
![Domain](images/domain.png)
114+
115+
**Job & Resume Section**
116+
117+
![Job](images/job.png)
118+
119+
---
120+
121+
## 🎬 Demo
122+
123+
Live site: [https://shadil-rayyan.github.io/cse-student-starter-guide/](https://shadil-rayyan.github.io/cse-student-starter-guide/)
124+
125+
* Interactive sidebar navigation
126+
* Search and instant navigation
127+
* Inline code copy and cheat sheets
128+
* Fully responsive and mobile-friendly
129+
130+
---
131+
132+
## 🤝 Contributing
133+
134+
Contributions are welcome! See [contributing.md](contributing.md) for guidelines.
135+
Steps: Fork → Branch → Commit → Pull Request
136+
137+
---
138+
139+
## 📚 Resources
140+
141+
Check [resources.md](resources.md) for curated books, websites, courses, and tools to accelerate your CSE journey.
142+
143+
---
144+
145+
## 📜 License
146+
147+
This project is licensed under the [MIT License](LICENSE).
148+
149+
---
150+
151+
## 📬 Contact
152+
153+
* LinkedIn: [Shadil AM](https://www.linkedin.com/in/shadil-am/)
154+
* GitHub: [shadil-rayyan](https://github.com/shadil-rayyan)
155+
* Email: [your-email@example.com](mailto:codecompass2024@gmail.com)

‎docs/cheatsheet.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Cheat Sheets for CSE Students
2+
3+
Quick references to save time while coding or working on projects.
4+
5+
## 🖥 Programming
6+
- **Python**
7+
```python
8+
# Swap two variables
9+
a, b = b, a
10+
# List comprehension
11+
squares = [x*x for x in range(5)]

‎docs/contributing.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to CSE Starter Guide Kit
2+
3+
Thank you for considering contributing! Your help makes this guide better for everyone.
4+
5+
## How to Contribute
6+
1. **Fork the repository**
7+
Click the "Fork" button at the top of the repo.
8+
9+
2. **Clone your fork**
10+
```bash
11+
git clone https://github.com/your-username/cse-student-starter-guide.git
12+
Create a new branch
13+
14+
bash
15+
Copy code
16+
git checkout -b feature/my-new-page
17+
Make your changes
18+
19+
Add new topics, correct typos, or improve formatting.
20+
21+
Follow the existing folder structure:
22+
23+
core/, domain/, college/, etc.
24+
25+
Commit your changes
26+
27+
bash
28+
Copy code
29+
git add .
30+
git commit -m "Add new topic X"
31+
Push to your branch
32+
33+
bash
34+
Copy code
35+
git push origin feature/my-new-page
36+
Create a Pull Request
37+
Go to the original repository and submit your PR.
38+
39+
Guidelines
40+
Keep content beginner-friendly.
41+
42+
Use markdown formatting consistently.
43+
44+
Check links and references before submitting.
45+
46+
Your contributions help future CSE students learn faster!

‎docs/resources.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Resources for CSE Students
2+
3+
A curated list of books, courses, websites, and tools for CSE students.
4+
5+
## 📚 Books
6+
- **Programming & Algorithms**
7+
- *Introduction to Algorithms* – Cormen et al.
8+
- *Clean Code* – Robert C. Martin
9+
- **Data Structures**
10+
- *Data Structures and Algorithms in Java* – Goodrich
11+
- **Operating Systems**
12+
- *Operating System Concepts* – Silberschatz et al.
13+
- **Networking**
14+
- *Computer Networking: A Top-Down Approach* – Kurose & Ross
15+
16+
## 💻 Online Courses & Tutorials
17+
- **FreeCodeCamp:** [https://www.freecodecamp.org](https://www.freecodecamp.org)
18+
- **CS50 by Harvard:** [https://cs50.harvard.edu](https://cs50.harvard.edu)
19+
- **MIT OCW Computer Science:** [https://ocw.mit.edu](https://ocw.mit.edu)
20+
- **Coursera / edX:** Various CSE specializations
21+
22+
## 🌐 Useful Websites
23+
- StackOverflow – Q&A for programmers
24+
- GeeksforGeeks – Algorithms, Data Structures, and tutorials
25+
- HackerRank / LeetCode / Codeforces – Competitive programming
26+
- GitHub – Explore open-source projects
27+
28+
## 🛠 Tools
29+
- VS Code – Editor
30+
- Git & GitHub – Version control
31+
- Linux / Ubuntu – Development environment
32+
- Postman – API testing
33+
- Figma – UI/UX design
34+
35+
> Tip: Focus on one domain at a time and gradually expand.

‎images/domain.png‎

250 KB
Loading

‎images/home.png‎

235 KB
Loading

‎images/job.png‎

268 KB
Loading

‎mkdocs.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ repo_url: https://github.com/shadil-rayyan/cse-student-starter-guide
55

66
theme:
77
name: material
8+
font:
9+
text: Roboto
10+
code: Roboto Mono
811
features:
912
- navigation.instant
1013
- navigation.tracking
@@ -13,6 +16,60 @@ theme:
1316

1417
logo: assets/logo.png
1518
favicon: assets/logo.png
19+
nav:
20+
- Home: index.md
21+
- Core: # Start with fundamentals first
22+
- Programming Language: core/programming_language.md
23+
- Git & GitHub:
24+
- Git: core/git.md
25+
- GitHub: core/github.md
26+
- Linux: core/linux.md
27+
- Typing: core/typing.md
28+
- Productivity: core/productivity.md
29+
- Games: core/game.md
30+
- Daily Reading: # Encourage daily learning habits
31+
- Engineering Blogs: daily-reading/enginerring-blog.md
32+
- Newsletter: daily-reading/newsletter.md
33+
- Substack: daily-reading/substack.md
34+
- Domain: # Explore different CS domains
35+
- Android: domain/android.md
36+
- Web Development: domain/web-dev.md
37+
- UI/UX: domain/ui-ux.md
38+
- Game Development: domain/game-development.md
39+
- Artificial Intelligence: domain/artificial-intelligence.md
40+
- Data Science: domain/data-science.md
41+
- Blockchain: domain/blockchain.md
42+
- Cyber Security: domain/cyber-security.md
43+
- DevOps: domain/devops.md
44+
- Embedded Systems: domain/Embedded System.md
45+
- AR & XR: domain/Ar &Xr.md
46+
- Robotics: domain/robotics.md
47+
- QA: domain/QA.md
48+
- College: # Academic guidance
49+
- Syllabus: college/syllabus.md
50+
- Hackathon: college/hackathon.md
51+
- Placement: college/placement.md
52+
- Scholarship: college/scholarship.md
53+
- Identity Card: college/identity-card.md
54+
- Seniors: college/seniors.md
55+
- Harsh Reality: college/harsh-reality.md
56+
- Jobs: # Career prep
57+
- Resume: job/resume.md
58+
- Portfolio Website: job/portfolio-website.md
59+
- Open Source: # Community and collaboration
60+
- What is Open Source?: open-source/what_open_source.md
61+
- Programs: open-source/program.md
62+
- Social Media: # Networking & communities
63+
- LinkedIn: social-media/linkedln.md
64+
- Discord: social-media/discord.md
65+
- Reddit: social-media/reddit.md
66+
- Slack: social-media/slack.md
67+
- WhatsApp Channel: social-media/whatsapp-channel.md
68+
- YouTube: social-media/youtube.md
69+
- Resources: resources.md # Extra materials
70+
- Cheat Sheets: cheatsheet.md
71+
- FAQ: faq.md
72+
- Contributing: contributing.md
1673

1774
plugins:
1875
- search

0 commit comments

Comments
 (0)