Skip to content

docs: refactor README for clarity and organization #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Junyi-99 merged 1 commit into from
Dec 17, 2025
Merged

docs: refactor README for clarity and organization #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 11 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
This enables multi-step reasoning, reviewer-style critique, and structured revision passes beyond standard chat-based assistance.

<div align="center">
<a href="https://chromewebstore.google.com/detail/paperdebugger/dfkedikhakpapbfcnbpmfhpklndgiaog" target="_blank"><strong>🚀 Install from Chrome Web Store</strong></a> • <a href="https://github.com/PaperDebugger/paperdebugger/releases/latest" target="_blank"><strong>📦 Download Latest Release</strong></a>
<a href="https://chromewebstore.google.com/detail/paperdebugger/dfkedikhakpapbfcnbpmfhpklndgiaog" target="_blank"><strong>🚀 Install from Chrome Web Store</strong></a>
</div>

<div align="center">
Expand All @@ -23,7 +23,7 @@ This enables multi-step reasoning, reviewer-style critique, and structured revis
<img src="docs/imgs/preview1.png" width="96%" style="margin: 0 1.5%; border-radius: 0.5rem;"/>
</div>

## 🌐 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. <br>
Stay connected with the PaperDebugger community! Join our [Discord](https://discord.gg/WwTMzzt9xD) or WeChat channels for updates, announcements, and support.

Expand All @@ -33,15 +33,14 @@ Stay connected with the PaperDebugger community! Join our [Discord](https://disc
</div>


## 📋 Table of Contents
## Table of Contents

- [📋 Table of Contents](#-table-of-contents)
- [✨ Features](#-features)
- [🎯 Quick Start](#-quick-start)
- [Features](#-features)
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table of contents link anchor '#-features' does not match the actual heading '## ✨ Features' on line 58. Markdown anchor links are generated from heading text, so this link should be '#-features' to match the emoji in the heading.

Copilot uses AI. Check for mistakes.
- [Quick Start](#-quick-start)
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table of contents link anchor '#-quick-start' does not match the actual heading '## 🎯 Quick Start' on line 71. The link should be '#-quick-start' to correctly reference the heading with its emoji.

Copilot uses AI. Check for mistakes.
- [For Users](#for-users)
- [Custom Endpoint Configuration](#custom-endpoint-configuration)
- [🏗️ Architecture Overview](#️-architecture-overview)
- [🛠️ Development Setup](#️-development-setup)
- [Architecture Overview](#️-architecture-overview)
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The anchor link '️-architecture-overview' contains an incorrect emoji representation. The actual heading '## 🏗️ Architecture Overview' on line 99 should be referenced as '#️-architecture-overview' to match properly.

Copilot uses AI. Check for mistakes.
- [Development Setup](#️-development-setup)
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The anchor link '️-development-setup' contains an incorrect emoji representation. The actual heading '## 🛠️ Development Setup' on line 115 should be referenced as '#️-development-setup' to match properly.

Copilot uses AI. Check for mistakes.
- [Prerequisites](#prerequisites)
- [System Requirements](#system-requirements)
- [Development Tools](#development-tools)
Expand All @@ -65,27 +64,20 @@ 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

## 🎯 Quick Start

### For Users

1. **Install the Extension**
1. **Install the extension**
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The capitalization has changed from "Install the Extension" to "Install the extension" (lowercase 'e'). This is inconsistent with step 2 which uses "Ready to use" (lowercase). For consistency in step numbering style, consider either capitalizing both steps or keeping both lowercase, but the current mixed approach lacks uniformity.

Copilot uses AI. Check for mistakes.
- [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
Expand Down