Merge pull request #6 from shadil-rayyan/improve-documentation

codecompass-1 · web-flow · commit c2782063ff77 · 2025-10-03T01:27:05.000+05:30
Improve documentation and add missing Discord content
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,58 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and maintainers pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+---
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy toward other community members
+
+Examples of unacceptable behavior:
+
+- Harassment, intimidation, or discrimination in any form
+- Personal attacks or insults
+- Public or private harassment
+- Publishing others' private information without consent
+- Any other conduct that could reasonably be considered inappropriate in a professional setting
+
+---
+
+## Enforcement
+
+Project maintainers are responsible for enforcing this code of conduct.  
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting **[EMAIL HERE]**. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
+
+Maintainers who do not follow or enforce the Code of Conduct may face temporary or permanent removal from the project.
+
+---
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+---
+
+## Enforcement Guidelines
+
+1. **Report behavior** by contacting **[EMAIL HERE]**.  
+2. **Maintain confidentiality**.  
+3. **Investigate and document** incidents thoroughly.  
+4. **Take action** such as warnings, temporary suspension, or banning if needed.  
+
+---
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,107 @@
+
+
+## **CONTRIBUTING.md**
+
+````markdown
+# Contributing to CSE Student Starter Guide
+
+Thank you for your interest in contributing to the CSE Student Starter Guide! 🎉  
+This repository aims to provide a comprehensive, beginner-friendly resource for Computer Science students to explore core concepts, tools, and career essentials.
+
+We welcome contributions of all kinds — whether it's improving documentation, adding new resources, or suggesting enhancements. Your input helps make this guide more valuable for everyone.
+
+---
+
+## 🚀 How to Contribute
+
+### 1. Fork the Repository
+
+Start by forking the repository to your GitHub account.
+
+### 2. Clone Your Fork
+
+Clone your fork to your local machine:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/cse-student-starter-guide.git
+cd cse-student-starter-guide
+````
+
+### 3. Create a New Branch
+
+Create a new branch for your changes:
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+### 4. Make Your Changes
+
+Make your changes locally. If you're adding new resources or topics, please ensure they align with the existing structure and formatting.
+
+### 5. Preview Changes Locally
+
+To preview your changes locally, you can use MkDocs:
+
+```bash
+mkdocs serve
+```
+
+This will start a local server at `http://127.0.0.1:8000/` where you can view your changes.
+
+### 6. Commit Your Changes
+
+Commit your changes with a clear and concise message:
+
+```bash
+git add .
+git commit -m "Add new resource on [Topic]"
+```
+
+### 7. Push to Your Fork
+
+Push your changes to your fork:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 8. Open a Pull Request
+
+Open a pull request (PR) to the `main` branch of the original repository. In your PR description:
+
+* Provide a brief summary of your changes.
+* Reference any related issues (e.g., `Fixes #1`).
+* If applicable, include screenshots or examples.
+
+---
+
+## 📚 Guidelines for Contributions
+
+* **Documentation**: Ensure clarity and accuracy. Use proper formatting and links.
+* **Content**: Add resources that are relevant, up-to-date, and beneficial for CSE students.
+* **Tone**: Maintain a friendly, inclusive, and professional tone throughout.
+
+---
+
+## 🧪 Reporting Issues
+
+If you encounter any issues or have suggestions:
+
+* Check the [Issues](https://github.com/CodeCompasss/cse-student-starter-guide/issues) tab to see if it's already reported.
+* If not, open a new issue with a clear description and steps to reproduce (if applicable).
+
+---
+
+## 🤝 Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Let's maintain a welcoming and respectful environment for all contributors.
+
+---
+
+## 🙏 Thank You!
+
+Your contributions help build a valuable resource for CSE students worldwide. Thank you for your time and effort in making this guide better!
+
+Happy contributing! 🚀
+
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/social-media/discord.md b/docs/social-media/discord.md
@@ -1,61 +1,55 @@
 
-## 1. **Community and Collaboration**
 
-* Discord hosts **thousands of servers** dedicated to programming languages, tech stacks, frameworks, and tools (like Python, React, Rust, AI, etc.).
-* Developers can **ask questions, share ideas, and get instant help** from peers.
-* Unlike forums or email chains, Discord feels more like a **real-time tech hangout**.
+## **Using Discord for CSE Students**
 
-## 2. **Casual, Yet Productive**
+Discord isn’t just for gamers — it has become one of the **most powerful communication platforms for students, developers, and tech communities**. For CSE students, it can be a game-changer if used effectively.
 
-* It's less formal than platforms like LinkedIn or Stack Overflow.
-* You can **chat, voice call, or screen share** easily — perfect for quick debugging or pair programming.
-* Many developers find it easier to **connect with mentors or collaborators** in a laid-back environment.
+### **1. Join Relevant Communities**
 
-## 3. **Learning in Public**
+* Many universities, programming communities, and open-source projects have **Discord servers** where students can:
 
-* Servers often have **channels for learning resources**, tutorials, project showcases, and code reviews.
-* You can **see how others think, solve problems, and write code** — which is a great way to grow.
-* Participating in discussions or helping others builds **confidence and knowledge**.
+  * Ask questions about assignments, projects, or coding problems.
+  * Discuss technology trends, career guidance, and internships.
+  * Network with peers and professionals in the same field.
 
-## 4. **Open Source and Hackathons**
+### **2. Collaborate on Projects**
 
-* Many open source communities use Discord to **coordinate development, onboard contributors, and run events**.
-* Hackathons and coding challenges are often hosted via Discord servers, giving you a chance to **practice, network, and even win prizes**.
+* Discord provides **voice channels, text channels, and file sharing**, making it ideal for:
 
----
-
-# How Discord Can Help You Grow
+  * Team projects or hackathons.
+  * Study groups or coding clubs.
+  * Real-time collaboration and brainstorming.
 
-## 🔹 **Stay Updated**
+### **3. Learning and Mentorship**
 
-* Join servers for specific technologies (like `r/learnprogramming`, `DevCord`, or `AI Coffeehouse`) to get **daily updates on trends and tools**.
-* Follow new releases, updates, and best practices **faster than waiting for a blog or course**.
+* Many servers have dedicated channels for **learning new programming languages, frameworks, and tools**.
+* Experienced developers often mentor students, answer questions, and provide feedback on projects.
+* Participating actively can help you **gain practical knowledge beyond the classroom**.
 
-## 🔹 **Practice Communication**
+### **4. Stay Updated with Tech News**
 
-* Explaining your code or helping someone else sharpens your **technical communication skills**, which are crucial in jobs.
-* You can **give and receive feedback** that makes your code better.
+* Several Discord communities share:
 
-## 🔹 **Build a Network**
+  * Latest job openings, internships, and scholarships.
+  * Free workshops, webinars, and coding competitions.
+  * Open-source contributions and collaborative opportunities.
 
-* You’ll meet developers at **all experience levels** — from students to senior engineers.
-* This network can lead to **job referrals, project collaborations, or mentorships**.
+### **5. Build Your Network**
 
-## 🔹 **Get Feedback on Projects**
+* Engaging in discussions, helping others, and sharing your work on Discord can help you:
 
-* Share what you’re working on and get **real feedback** from people who understand code.
-* This is super helpful for improving projects or portfolios.
+  * Make connections with like-minded peers.
+  * Find potential collaborators for projects or hackathons.
+  * Get noticed by mentors or recruiters.
 
-## 🔹 **Explore Career Paths**
+### **Tips for Students**
 
-* Many servers have **channels dedicated to internships, freelancing, job hunting, and resumes**.
-* You can learn how others broke into the industry and **get tips from people actually working in your dream roles**.
+* Respect community guidelines — always be professional and polite.
+* Don’t just lurk; ask questions and contribute to discussions.
+* Take notes or bookmark resources shared in channels for later reference.
+* Use Discord alongside other platforms like GitHub, LinkedIn, and Stack Overflow for a well-rounded learning experience.
 
 ---
 
-# TL;DR:
-
-Discord is **like a 24/7 co-working space for developers**. If you use it wisely — join the right servers, engage in conversations, build relationships, and share your work — it can massively speed up your learning and professional growth.
-
----
+**Bottom line:** Discord can be your **study group, mentor, and networking hub all in one**, helping you grow faster as a CSE student.
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,7 +68,6 @@ nav:
       - YouTube: social-media/youtube.md
   - Resources: resources.md  # Extra materials
   - Cheat Sheets: cheatsheet.md
-  - FAQ: faq.md
   - Contributing: contributing.md
 
 plugins:
