Feature/docs site (#87)

* Hugo site

* Hugo

* Dark mode

* Update privacy and tos for stores

* Add netliy

Author: blopker

.github/workflows/deploy-hugo-pages.yml

@@ -0,0 +1,60 @@
+name: Deploy Hugo site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: 'latest'
+          extended: true
+
+      - name: Build with Hugo
+        run: |
+          cd docs
+          hugo --minify
+        
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/public"
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -13,6 +13,9 @@
 migrate_working_dir/
 android/app/.cxx/
 
+docs/public
+.hugo_build.lock
+
 # IntelliJ related
 *.iml
 *.ipr

Makefile

@@ -38,6 +38,9 @@ release: tag build
 icons:
 	dart run flutter_launcher_icons
 
+docs:
+	cd docs && hugo build
+
 clean:
 	flutter clean
 	rm -rf build

docs/.hugo_build.lock

@@ -0,0 +1,5 @@
++++
+date = '{{ .Date }}'
+draft = true
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
++++

docs/archetypes/default.md

@@ -0,0 +1,10 @@
+---
+title: SuperDuper App Legal Documents
+---
+
+SuperDuper is an open source alternative ebike app available for iOS and Android platforms, designed to provide a modern interface for your compatible ebike.
+
+* [Terms of Service](/tos/)
+* [Privacy Policy](/privacy/)
+
+For more information about SuperDuper, visit our [GitHub repository](https://github.com/blopker/superduper).

docs/content/_index.md

@@ -0,0 +1,112 @@
+---
+title: Privacy Policy
+---
+
+# Privacy Policy for SuperDuper App
+
+**Effective Date: May 4th, 2025**
+
+## Introduction
+
+This Privacy Policy applies to the SuperDuper mobile application (the "App") developed by SuperDuper Team ("we", "our", or "us"). This policy describes how we handle your data and is designed to inform users about our commitment to privacy.
+
+As developers of SuperDuper, we believe in transparency about how our app functions and what information it does and does not collect. We have designed SuperDuper with privacy in mind.
+
+## Data Controller
+
+SuperDuper Team is the data controller responsible for your personal information collected through the App.
+
+## Information Collection and Use
+
+SuperDuper is designed to connect to your ebike via Bluetooth. The app is designed to work offline and does not require an internet connection or user account.
+
+### Data We Do Not Collect
+
+- No personal information (name, email, phone number, etc.)
+- No location tracking or location history
+- No usage statistics
+- No advertising identifiers
+- No analytics data
+- No browsing history
+
+### Data Stored on Your Device Only
+
+The following information is stored locally on your device only and is never transmitted to us or any third parties:
+
+- Bluetooth information about your ebike(s) to enable connection
+- Custom bike names you create
+- Your preferred bike settings
+
+### Legal Basis for Processing
+
+We process the limited data described above based on our legitimate interest to provide you with the functionality of the App as described.
+
+### Data Retention and Deletion
+
+All data is stored locally on your device only. This data is retained as long as you have the App installed on your device. When you uninstall the App, all data associated with the App is automatically deleted. We do not retain any of your data on our servers, as we do not collect any data from your device.
+
+If you wish to delete your data before uninstalling the App, you can clear the App's data through your device's settings menu:
+- On Android: Settings > Apps > SuperDuper > Storage > Clear Data
+- On iOS: Settings > General > iPhone Storage > SuperDuper > Delete App
+
+### Data Security
+
+We implement appropriate technical and organizational measures to protect the data that is stored locally on your device. However, no method of electronic storage is 100% secure. While we strive to use commercially acceptable means to protect your personal data, we cannot guarantee its absolute security.
+
+## Required App Store Data
+
+The only data that may be collected is that which is automatically collected by the Apple App Store and Google Play Store as part of their standard operations. This includes:
+
+- App crash reports (if you choose to share them)
+- Basic installation metrics
+- App store download statistics
+
+This information is collected by Apple and Google, not by SuperDuper, and is subject to their respective privacy policies:
+- [Google Privacy Policy](https://policies.google.com/privacy)
+- [Apple Privacy Policy](https://www.apple.com/legal/privacy/)
+
+## Permissions
+
+SuperDuper requests the following permissions:
+
+- **Bluetooth**: Required to connect to your ebike
+- **Location** (Android only): Required by Android's system for Bluetooth scanning. We do not track, collect, or store your location information.
+- **Background processing** (for Android Background Lock feature): Required to maintain Bluetooth connection when the app is in the background.
+
+These permissions are used solely for the functionality of the app and not for data collection purposes.
+
+## Third-Party Services
+
+The App does not use any third-party analytics, advertising, or tracking services.
+
+## Data Transfers
+
+The App does not transfer any personal data to third parties or across borders.
+
+## Children's Privacy
+
+SuperDuper does not knowingly collect any personally identifiable information from children under 13 years of age. The App does not target children under the age of 13. If you are a parent or guardian and you believe your child has provided us with personal information, please contact us so we can take necessary actions.
+
+## Your Rights
+
+Depending on your jurisdiction, you may have certain rights regarding your personal information. Since we do not collect any personal information, most of these rights are automatically fulfilled. However, you still have the right to:
+
+- Access: View what data is stored locally on your device through the App's interface.
+- Delete: Uninstall the App or clear its data through your device settings.
+- Complain: Contact the relevant data protection authority if you believe your rights have been violated.
+
+## Changes to This Privacy Policy
+
+We may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on this page and updating the "Effective Date" at the top of this Privacy Policy. Changes to this Privacy Policy are effective when they are posted.
+
+## Open Source
+
+SuperDuper is an open source application. The source code is available for review at [https://github.com/blopker/superduper](https://github.com/blopker/superduper). You can verify our privacy practices by examining the code yourself.
+
+## Contact Us
+
+If you have any questions, concerns, or feedback about this Privacy Policy or the App's privacy practices, you can contact us by:
+
+- Opening an issue on our GitHub repository at [https://github.com/blopker/superduper/issues](https://github.com/blopker/superduper/issues)
+
+We will respond to your inquiry as soon as reasonably possible.

docs/content/privacy.md

@@ -0,0 +1,117 @@
+---
+title: Terms of Service
+---
+
+# Terms and Conditions for SuperDuper App
+
+**Effective Date: May 4th, 2025**
+
+## Introduction
+
+These Terms and Conditions ("Terms") govern your use of SuperDuper (the "App"), an open source alternative ebike app available for iOS and Android platforms developed by SuperDuper Team ("we", "our", or "us").
+
+By downloading or using the App, these Terms will automatically apply to you. Please read them carefully before using the App. By using the App, you confirm that you accept these Terms and that you agree to comply with them. If you do not agree to these Terms, you must not download or use the App.
+
+## Definitions
+
+- **App**: The SuperDuper mobile application
+- **User**: Any individual who downloads or uses the App
+- **Device**: The smartphone or tablet used to access the App
+- **Ebike**: Any electric bicycle compatible with the App
+
+## License to Use
+
+SuperDuper is an open source application, with its source code available at [https://github.com/blopker/superduper](https://github.com/blopker/superduper). The app is licensed under open source licensing terms that can be found in the repository. 
+
+This license gives you the right to download and use the App on your personal device(s) and to modify the source code according to the applicable open source license. 
+
+While the App is open source, the project name, logos, and branding elements are protected by intellectual property rights and are not covered by the open source license.
+
+You're welcome to examine and modify the source code according to the applicable open source license, but you may not misrepresent the App as your own or use the SuperDuper brand in a way that implies endorsement.
+
+## User Responsibilities
+
+When using the App, you agree to:
+
+1. Use the App only for its intended purpose of controlling compatible ebikes
+2. Use the App in compliance with all applicable laws and regulations
+3. Not attempt to gain unauthorized access to any part of the App or servers hosting associated services
+4. Not use the App in any way that could damage, disable, overburden, or impair the App or interfere with others' use of the App
+
+## App Functionality and Changes
+
+SuperDuper is committed to providing a useful and efficient app for controlling compatible ebikes. For that reason, we reserve the right to make changes to the App at any time and for any reason. We may update the App for bug fixes, improved compatibility with different devices, or to add new features.
+
+The App is currently provided free of charge and will remain so. However, we make no promises that it will always be available or that it will function exactly as you expect. We may suspend, withdraw, or restrict the availability of all or any part of the App for business and operational reasons.
+
+## Device Security and Compatibility
+
+SuperDuper connects to ebikes using Bluetooth technology. It's your responsibility to keep your device and access to the App secure. We recommend that you do not jailbreak or root your device, which could compromise your device's security and may cause the App to function improperly or not at all.
+
+We recommend using the latest version of your device's operating system to ensure optimal App performance and security.
+
+## Third-Party Services
+
+The App may use third-party services that declare their own Terms and Conditions, including:
+
+* [Google Play Services](https://policies.google.com/terms)
+* [Apple App Store Services](https://www.apple.com/legal/internet-services/itunes/)
+
+Your use of these services is governed by their respective terms of service and privacy policies.
+
+## Limitations of Liability
+
+To the maximum extent permitted by law, SuperDuper is provided "as is" without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, title, and non-infringement.
+
+The developers of SuperDuper cannot take responsibility for:
+
+- The App not working at full functionality if you don't have proper Bluetooth connectivity
+- Any battery consumption on your device while using the App
+- Any issues arising from improper use of the App
+- Any damage or modifications to your ebike resulting from use of the App
+
+By using SuperDuper, you accept that connecting to and controlling your ebike is done at your own risk. We accept no liability for any loss, direct or indirect, you experience as a result of using this App.
+
+In no event shall the developers of SuperDuper be liable for any damages whatsoever, including but not limited to any direct, indirect, special, incidental, or consequential damages of any kind, whether in an action of contract, negligence, or other tortious action, arising out of or in connection with the use or inability to use the App.
+
+## App Updates
+
+We may update the App periodically to improve functionality, fix bugs, or meet platform requirements. The App is currently available on Android and iOS - the requirements for these systems may change, and you'll need to download updates if you want to keep using the App.
+
+While we strive to keep the App updated and compatible with current operating systems, we don't guarantee that it will always be updated to be compatible with all versions of Android and iOS. You agree to accept updates to the App when offered to you.
+
+We may also need to stop providing the App, and may terminate use of it at any time without giving advance notice. Unless otherwise stated, upon any termination: (a) the rights and licenses granted to you in these Terms will end; (b) you must stop using the App, and (if needed) delete it from your device.
+
+## Intellectual Property
+
+The App and all associated intellectual property rights, including but not limited to copyright, trademarks, and trade secrets, are owned by the SuperDuper Team. The open source license grants you certain rights to use and modify the code, but it does not transfer ownership of the intellectual property to you.
+
+## Dispute Resolution
+
+These Terms shall be governed by and construed in accordance with the laws of the State of California, without regard to its conflict of law provisions.
+
+Any dispute arising out of or relating to these Terms or the App shall first be attempted to be resolved through informal negotiation. If the dispute cannot be resolved through informal negotiation, it shall be resolved through binding arbitration in accordance with the rules of the American Arbitration Association.
+
+## Severability
+
+If any provision of these Terms is found to be unenforceable or invalid, that provision will be limited or eliminated to the minimum extent necessary so that these Terms will otherwise remain in full force and effect and enforceable.
+
+## Waiver
+
+No waiver of any term of these Terms shall be deemed a further or continuing waiver of such term or any other term, and our failure to assert any right or provision under these Terms shall not constitute a waiver of such right or provision.
+
+## Changes to Terms and Conditions
+
+We may update our Terms and Conditions from time to time. We will notify you of any changes by posting the new Terms and Conditions on the App's website and updating the "Effective Date" at the top of these Terms. You are advised to review this page periodically for any changes.
+
+Your continued use of the App after we post any modifications to the Terms will constitute your acknowledgment of the modifications and your consent to abide and be bound by the modified Terms.
+
+## Contact Us
+
+If you have any questions, concerns, or feedback about these Terms or the App, you can contact us by:
+
+- Email: terms@superduper-app.example.com
+- Postal Mail: SuperDuper Team, 123 Main Street, Anytown, CA 12345, USA
+- Opening an issue on our GitHub repository at [https://github.com/blopker/superduper/issues](https://github.com/blopker/superduper/issues)
+
+We will respond to your inquiry as soon as reasonably possible.

docs/content/tos.md

@@ -0,0 +1,4 @@
+baseURL = '/'
+languageCode = 'en-us'
+title = 'SuperDuper App - Legal'
+theme = "sd"

docs/hugo.toml

@@ -0,0 +1,5 @@
++++
+date = '{{ .Date }}'
+draft = true
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
++++