👋 Welcome to ShareJadPi
Your Journey Starts Here
Welcome! This documentation will guide you from zero to expert, step by step.
🎯 What You'll Learn
This documentation follows a clear learning path:
📚 Learning Path
Phase 1: Start Here ⭐ You are here!
- Introduction (this page) - Overview and learning path
- What is ShareJadPi? - Core concept and purpose
- Installation - Get ShareJadPi running on your machine
Phase 2: Learn the Basics 🎓 4. First Steps - Launch and access the app 5. Uploading Files - Learn to upload files 6. Downloading Files - Learn to download files 7. Managing Files - Delete and organize files
Phase 3: Understanding ShareJadPi 🏗️ 8. How It Works - Architecture and technical design 9. Features Breakdown - Deep dive into all features 10. Development Timeline - Project evolution and history
Phase 4: For Developers 💻 11. API Reference - Complete REST API documentation 12. Development Server - Development environment setup 13. Configuration Options - Customize ShareJadPi 14. Contributing - Help improve ShareJadPi
Phase 5: Advanced 🚀 15. Deployment Guide - Deploy for production 16. Future Roadmap - What's coming next
🎓 Who Is This For?
End Users
Want to share files on your local network
- ✅ Start with Phases 1-2
- ✅ Learn basic operations
- ✅ Skip technical details
Developers
Want to integrate or extend ShareJadPi
- ✅ Read all phases
- ✅ Focus on Phases 3-4
- ✅ Use API reference
Organizations
Want to deploy for teams
- ✅ Read Phases 1, 3, 5
- ✅ Review security notes
- ✅ Check deployment guide
⚡ Quick Navigation
If you want to...
- 🚀 Get started immediately → Installation →
- 📖 Understand what ShareJadPi is → What is ShareJadPi? →
- 💻 Use the API → API Reference →
- 🔧 Contribute to development → Contributing →
- 🏗️ Understand the architecture → Architecture →
📖 How to Use This Documentation
🎯 Recommended Path
Follow the numbered sequence in the sidebar (1 → 16). Each page builds on the previous one.
🔍 Search Anything
Use the search bar at the top to find specific topics quickly.
🌐 Navigation Tips
- Sidebar numbers show the recommended reading order
- Collapsed sections can be expanded by clicking
- "Edit on GitHub" link at the bottom of each page for corrections
- Previous/Next buttons at the bottom navigate sequentially
🎯 What is ShareJadPi?
ShareJadPi is a modern, lightweight file sharing application for local networks.
Think of it as your personal file sharing server that runs on your computer. Anyone on your network can:
- Upload files through a web browser
- Download files you've shared
- All without installing anything!
Current Version: 4.5.4-dev (Development)
Key Highlights
🚀 Ready to Start?
Next Step: Learn What ShareJadPi Is
Understanding the core concept will help you get the most out of ShareJadPi.
💬 Need Help?
Found an issue or have questions?
- 🐛 Report bugs on GitHub Issues
- 💡 Suggest features in Discussions
- 📧 Contact: [Your Email]
- ⭐ Star the project if you find it useful!