update docs

Author: Bingxi Zhao

.github/workflows/update-roster.yml

@@ -1,9 +1,9 @@
 name: Update Repo Roster
 
 on:
-  # Run every 2 hours
+  # Run twice a day (at 00:00 and 12:00 UTC)
   schedule:
-    - cron: '0 */2 * * *'
+    - cron: '0 0,12 * * *'
   # Allow manual trigger
   workflow_dispatch:
   # Run when stars/forks might change (on push to main)

CONTRIBUTING.md

@@ -22,10 +22,8 @@ We use automated tools to maintain code quality:
 - **detect-secrets** — Security scanning
 
 > [!IMPORTANT]
-> **Before submitting a PR, you MUST run:**
-> ```bash
-> pre-commit run --all-files
-> ```
+> **Before submitting a PR, you MUST run:** `pre-commit run --all-files`
+>
 > CI will automatically check this and **reject PRs** that fail pre-commit checks.
 
 ### Setting Up Pre-commit (First Time Only)

README.md

@@ -225,7 +225,6 @@
 ## 📋 Todo
 
 > 🌟 Star to follow our future updates!
-- [-] Support Local LLM Services (e.g., ollama)
 - [-] Refactor RAG Module (see [Discussions](https://github.com/HKUDS/DeepTutor/discussions))
 - [ ] Deep-coding from idea generation
 - [ ] Personalized Interaction with Notebook

assets/roster/forkers.svg

@@ -67,7 +67,7 @@ export default defineConfig({
 
     footer: {
       message: 'Released under the AGPL-3.0 License.',
-      copyright: 'Copyright © 2024-2025 HKUDS'
+      copyright: 'Copyright © 2025-2026 DeepTutor Team @ HKU'
     },
 
     search: {

assets/roster/stargazers.svg

@@ -1,8 +1,8 @@
 # Contributing
 
-Thank you for your interest in contributing to DeepTutor! 🎉
+Thank you for your interest in contributing to DeepTutor! That means a lot for our team! 🎉
 
-We welcome contributions from the community! To ensure code quality and consistency, please follow the guidelines below.
+You can join our [Discord community](https://discord.gg/aka9p9EW) for further discussion.
 
 ## Ways to Contribute
 
@@ -11,6 +11,15 @@ We welcome contributions from the community! To ensure code quality and consiste
 - 📖 **Improve docs** — Fix typos, add examples
 - 🔧 **Submit PRs** — Code contributions welcome!
 
+## 🔄 Pull Request Process
+
+1. **Create a branch**: `git checkout -b feature/your-feature`
+2. **Make changes**: Follow existing code style and conventions
+3. **Test locally**: Ensure your changes work correctly
+4. **Run pre-commit**: `pre-commit run --all-files` ⚠️ **Required before PR!**
+5. **Commit**: Pre-commit hooks will auto-format your code
+6. **Push & PR**: Open a pull request with a clear description
+
 ## Development Setup
 
 ### 1. Fork and Clone
@@ -56,7 +65,9 @@ pre-commit install
 pre-commit run --all-files
 ```
 
-## Code Quality Tools
+> After installing Git hooks, they will run **automatically** on every commit — no need to remember!
+
+## 🛠️ Code Quality Tools
 
 We use automated tools to maintain code quality:
 
@@ -66,7 +77,11 @@ We use automated tools to maintain code quality:
 | **Prettier** | Frontend code formatting | `web/.prettierrc.json` |
 | **detect-secrets** | Security check | `.secrets.baseline` |
 
-> **Note**: The project uses **Ruff format** instead of Black to avoid formatting conflicts.
+::: warning IMPORTANT
+**Before submitting a PR, you MUST run:** `pre-commit run --all-files`
+
+CI will automatically check this and **reject PRs** that fail pre-commit checks.
+:::
 
 Every time you run `git commit`, pre-commit hooks will automatically:
 - Format Python code with Ruff
@@ -75,21 +90,15 @@ Every time you run `git commit`, pre-commit hooks will automatically:
 - Validate YAML/JSON files
 - Detect potential security issues
 
-## Pull Request Process
-
-1. **Create Branch**: `git checkout -b feature/amazing-feature`
-2. **Make Changes**: Write your code following the project's style
-3. **Test**: Ensure your changes work correctly
-4. **Commit**: Pre-commit hooks will automatically format your code
-5. **Push and PR**: Push to your fork and create a Pull Request
+> **Note**: The project uses **Ruff format** instead of Black to avoid formatting conflicts.
 
-### Common Commands
+## Common Commands
 
 ```bash
-# Normal commit (hooks run automatically)
+# Normal commit (hooks run automatically if installed)
 git commit -m "Your commit message"
 
-# Manually check all files
+# Manually check all files (do this before pushing!)
 pre-commit run --all-files
 
 # Update hooks to latest versions
@@ -99,15 +108,26 @@ pre-commit autoupdate
 git commit --no-verify -m "Emergency fix"
 ```
 
-## Contribution Guidelines
+## 📋 Commit Message Format
+
+```
+<type>: <short description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+**Types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
 
-1. **Fork and Clone**: Fork the repository and clone your fork
-2. **Create Branch**: Create a feature branch from `main`
-3. **Install Pre-commit**: Follow the setup steps above
-4. **Make Changes**: Write your code following the project's style
-5. **Test**: Ensure your changes work correctly
-6. **Commit**: Pre-commit hooks will automatically format your code
-7. **Push and PR**: Push to your fork and create a Pull Request
+**Examples**:
+- `feat`: for a new feature (MINOR version bump)
+- `fix`: for a bug fix (PATCH version bump)
+- `docs`: for documentation-only changes
+- `style`: for formatting changes (whitespace, semicolons)
+- `refactor`: for code changes that neither fix a bug nor add a feature
+- `test`: for adding or correcting tests
+- `chore`: for routine tasks (build processes, dependencies)
 
 ## Reporting Issues
 
@@ -122,8 +142,9 @@ Please be respectful and inclusive. We're building a welcoming community for lea
 ## Questions?
 
 - Open a [GitHub Discussion](https://github.com/HKUDS/DeepTutor/discussions)
+- Join our [Discord Community](https://discord.gg/aka9p9EW)
 - Check existing issues for similar questions
 
 ---
 
-❤️ Thank you for helping make DeepTutor better!
+### Let's build a tutoring system for the whole community TOGETHER! 🚀

docs/.vitepress/config.mts

@@ -4,12 +4,10 @@ Our vision for DeepTutor's future development.
 
 ## 🚀 Planned Features
 
-- [ ] **Project-based Learning** -- Generate incomplete coding projects for hands-on learning
-- [ ] **Deepcoding from Idea Generation** -- Transform research ideas into working prototypes
-- [ ] **Personalized Memory** -- Adapt tutoring style based on user learning history
-- [ ] **Docker Support** -- Containerized deployment
-- [ ] **Alternative RAG Techniques** -- More choice of base RAG methods.
-- [ ] **Local LLM Deployment** -- Support local LLM choice (e.g., Ollama)
+- [ ] **Deepcoding from Idea Generation** — Transform research ideas into working prototypes
+- [ ] **Personalized Memory** — Adapt tutoring style based on user learning history
+- [ ] **Alternative RAG Techniques** — More choice of base RAG methods
+
 
 ## 💭 Under Consideration
 

docs/community/contributing.md

@@ -12,8 +12,14 @@
 from concurrent.futures import ThreadPoolExecutor, as_completed
 import json
 import os
+import ssl
 import urllib.request
 
+# Create SSL context that doesn't verify certificates (for macOS compatibility)
+ssl_context = ssl.create_default_context()
+ssl_context.check_hostname = False
+ssl_context.verify_mode = ssl.CERT_NONE
+
 
 def fetch_github_api(url: str, token: str = None, count_only: bool = False) -> tuple:
     """Fetch data from GitHub API with pagination. Returns (users, total_count)."""
@@ -31,7 +37,7 @@ def fetch_github_api(url: str, token: str = None, count_only: bool = False) -> t
         req = urllib.request.Request(paginated_url, headers=headers)
 
         try:
-            with urllib.request.urlopen(req, timeout=30) as response:
+            with urllib.request.urlopen(req, timeout=30, context=ssl_context) as response:
                 data = json.loads(response.read().decode())
                 if not data:
                     break
@@ -48,7 +54,9 @@ def fetch_github_api(url: str, token: str = None, count_only: bool = False) -> t
                         paginated_url = f"{url}?per_page={per_page}&page={page}"
                         req = urllib.request.Request(paginated_url, headers=headers)
                         try:
-                            with urllib.request.urlopen(req, timeout=30) as resp:
+                            with urllib.request.urlopen(
+                                req, timeout=30, context=ssl_context
+                            ) as resp:
                                 more_data = json.loads(resp.read().decode())
                                 if not more_data:
                                     break
@@ -74,7 +82,7 @@ def fetch_avatar_as_base64(avatar_url: str, size: int = 48) -> str:
             avatar_url += f"?s={size}"
 
         req = urllib.request.Request(avatar_url, headers={"User-Agent": "Repo-Roster-Generator"})
-        with urllib.request.urlopen(req, timeout=10) as response:
+        with urllib.request.urlopen(req, timeout=10, context=ssl_context) as response:
             data = response.read()
             content_type = response.headers.get("Content-Type", "image/png")
             base64_data = base64.b64encode(data).decode("utf-8")