Welcome to the ProxyMe documentation! This guide will help you find the information you need.
- Installation Guide - Get started quickly
- Quick Start - 5-minute setup
- Main README - Project overview
- Troubleshooting - Common issues and solutions
- Build Instructions - How to build from source
- Contributing Guidelines - How to contribute
- Development Guides - Developer resources
- DeepSeek API Endpoints - DeepSeek API details
- API Endpoint Summary - Quick API reference
- Rider Integration Modes - Rider AI integration
docs/
├── README.md (This file)
├── user-guide/ (End-user documentation)
│ ├── INSTALLATION_GUIDE.md - Detailed installation
│ └── QUICK_START.md - Quick setup guide
├── development/ (Developer documentation)
│ ├── CHEATSHEET.md - Developer quick reference
│ └── DEBUGGING_GUIDE.md - Debugging tips
└── api/ (API documentation)
├── DEEPSEEK_API_ENDPOINTS.md
├── API_ENDPOINT_SUMMARY.md
└── RIDER_INTEGRATION_MODES.md
- Never used ProxyMe? → Start with Installation Guide
- Quick setup? → See Quick Start
- Problems installing? → Check Troubleshooting
- Configure models → See Main README
- Template system → See Quick Start
- Common issues → See Troubleshooting
- Want to help? → Read Contributing Guidelines
- Build from source → Follow Build Instructions
- Development tips → See Cheatsheet
- Debugging → See Debugging Guide
- API integration → See API docs
- Rider integration → See Rider Integration Modes
- Roadmap → See ROADMAP.md
When contributing documentation:
- Use clear, descriptive headings
- Include code examples where helpful
- Add cross-references to related docs
- Keep content up-to-date
- Follow markdown best practices
- Check this documentation index
- Search the main README
- Review Troubleshooting guide
- Ask in GitHub Discussions
Please open an issue or submit a pull request with updates.
See Contributing Guidelines for how to help improve the documentation.
Must Read:
- Main README - Start here
- Installation Guide - Get it working
- Troubleshooting - Fix common issues
- Contributing - Help improve ProxyMe
For Development:
- Build Instructions - Build from source
- Cheatsheet - Quick reference
- Debugging Guide - Debug issues
For Understanding:
- Rider Integration - How Rider connects
- API Documentation - API reference
- Roadmap - Future plans
Documentation Status: ✅ Current
Last Updated: October 2024
Happy reading! 📖