From a15ac7795b26c8a23bef7b46857b27f8395147bf Mon Sep 17 00:00:00 2001 From: Junyi Date: Wed, 17 Dec 2025 11:29:01 +0800 Subject: [PATCH] docs: refactor README for clarity and organization Updated README to improve clarity and structure, including changes to the community section and table of contents. --- README.md | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4307dcdf..fa7dec85 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This enables multi-step reasoning, reviewer-style critique, and structured revision passes beyond standard chat-based assistance.
- 🚀 Install from Chrome Web Store • 📦 Download Latest Release + 🚀 Install from Chrome Web Store
@@ -23,7 +23,7 @@ This enables multi-step reasoning, reviewer-style critique, and structured revis
-## 🌐 Social Media & Community Groups +## Community Our team is actively working to improve long-term reliability, hoping to iron out issues this month. Thank you for your patience.
Stay connected with the PaperDebugger community! Join our [Discord](https://discord.gg/WwTMzzt9xD) or WeChat channels for updates, announcements, and support. @@ -33,15 +33,14 @@ Stay connected with the PaperDebugger community! Join our [Discord](https://disc -## 📋 Table of Contents +## Table of Contents -- [📋 Table of Contents](#-table-of-contents) -- [✨ Features](#-features) -- [🎯 Quick Start](#-quick-start) +- [Features](#-features) +- [Quick Start](#-quick-start) - [For Users](#for-users) - [Custom Endpoint Configuration](#custom-endpoint-configuration) -- [🏗️ Architecture Overview](#️-architecture-overview) -- [🛠️ Development Setup](#️-development-setup) +- [Architecture Overview](#️-architecture-overview) +- [Development Setup](#️-development-setup) - [Prerequisites](#prerequisites) - [System Requirements](#system-requirements) - [Development Tools](#development-tools) @@ -65,7 +64,7 @@ PaperDebugger never modifies your project, it only reads and provides suggestion - **💬 Comment System**: Automatically generate and insert comments into your project - **📚 Prompt Library**: Custom prompt templates for different use cases - **🔒 Privacy First**: Your content stays secure - we only read, never modify -- **🧠 Multi-Agent Orchestration** – [XtraMCP](https://github.com/4ndrelim/academic-paper-mcp-server) support for literature-grounded research, AI-Conference review, and domain-specific revision +- **🧠 Multi-Agent Orchestration** – [XtraMCP](https://github.com/PaperDebugger/xtramcp) support for literature-grounded research, AI-Conference review, and domain-specific revision https://github.com/user-attachments/assets/6c20924d-1eb6-44d5-95b0-207bd08b718b @@ -73,19 +72,12 @@ https://github.com/user-attachments/assets/6c20924d-1eb6-44d5-95b0-207bd08b718b ### For Users -1. **Install the Extension** +1. **Install the extension** - [Chrome Web Store](https://chromewebstore.google.com/detail/paperdebugger/dfkedikhakpapbfcnbpmfhpklndgiaog) (Recommended) - - [Latest Release](https://github.com/PaperDebugger/paperdebugger/releases/latest) (Manual Install) -2. **Manual Installation** - - Download the latest release - - Open Chrome and go to `chrome://extensions/` - - Enable "Developer mode" - - Click "Load unpacked" or drag the extension file - -3. **Start Using** +2. **Ready to use** - Open any Overleaf project - - Click the PaperDebugger icon + - Click the PaperDebugger icon on the top-left - Begin chatting with your LaTeX assistant! ### Custom Endpoint Configuration