Welcome to the official documentation and home page repository for ShopSync!
Live site: https://shopsync.aadish.dev
This repository contains both the comprehensive documentation and the landing page for ShopSync. It serves as the central hub for:
- Documentation: Complete guides covering installation, features, development, and deployment
- Landing Page: A modern, responsive website showcasing ShopSync's features and capabilities
- User Guides: Step-by-step tutorials for getting started and using advanced features
- Developer Resources: Architecture details, API references, and contribution guidelines
Our documentation is built with Zensical using its MkDocs Material compatibility layer, and includes:
- Installation guides for Android and web platforms
- Firebase setup instructions
- Quick start tutorials
- Real-time synchronization
- Smart suggestions and AI integration
- Location-based shopping
- Export and import capabilities
- Home widgets and WearOS support
- Recycle bin for deleted items
- Project architecture and structure
- Contributing guidelines
- API documentation
- Deployment instructions
- Authentication and account management
- Creating and managing shopping lists
- Working with items and categories
- Sharing lists with family and friends
- Offline mode functionality
- Settings and customization
Access the documentation: Visit https://shopsync.aadish.dev/docs/ or navigate to the "Docs" tab on the landing page.
The ShopSync landing page is a React-based single-page application featuring:
- Home: Overview of ShopSync with key benefits
- Features: Detailed showcase of all features with visuals
- About: Information about the project and team
- Contact: Ways to get in touch and support
- Docs: Direct access to comprehensive documentation
The landing page is built with React and Vite, providing a fast and modern user experience.
We welcome contributions to improve our documentation! Whether you're fixing a typo, clarifying an explanation, or adding new content, your help is appreciated.
Please read our CONTRIBUTING.md file for guidelines on how to contribute to this documentation.
https://github.com/ASDev-Official/shopsync
This documentation is licensed under the GNU GPL v3.0 License - see the LICENSE file for details.
If you have questions or need help:
- Open an issue in this repository for documentation-related questions
- Visit the main ShopSync repository for application-specific issues
- Check our documentation for answers to common questions
Watch this repository to stay informed about documentation updates and improvements.