Add external documentation site

Author: Crustack

README.md

@@ -1,7 +1,7 @@
 <h2 align="center">
     <img src="fastlane/metadata/android/en-US/images/icon.png" alt="icon" width="90"/>
     <br />
-    <b>NotallyX | Minimalistic note taking app</b>
+    <b><a href="https://philkes.github.io/NotallyX/">NotallyX | Minimalistic note taking app</a></b>
     <p>
         <center>
             <a href='https://play.google.com/store/apps/details?id=com.philkes.notallyx&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' height='80'/></a>
@@ -23,9 +23,12 @@
   <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" alt="Image 7" style="width: 32%;"/>
 </div>
 
+
 ### Features
 [Notally](https://github.com/OmGodse/Notally), but eXtended
 
+<h4><a href="https://philkes.github.io/NotallyX/">See Documentation</a></h4>
+
 * Create **rich text** notes with support for bold, italics, mono space and strike-through
 * Create **task lists** and order them with subtasks (+ auto-sort checked items to the end)
 * Set **reminders** with notifications for important notes

app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/settings/SettingsFragment.kt

@@ -753,6 +753,7 @@ class SettingsFragment : Fragment() {
             Rate.setOnClickListener {
                 openLink("https://play.google.com/store/apps/details?id=com.philkes.notallyx")
             }
+            Documentation.setOnClickListener { openLink("https://philkes.github.io/NotallyX") }
             SourceCode.setOnClickListener { openLink("https://github.com/PhilKes/NotallyX") }
             Libraries.setOnClickListener {
                 val libraries =

app/src/main/res/layout/fragment_settings.xml

@@ -260,6 +260,13 @@
           android:layout_height="wrap_content"
           android:text="@string/donate" />
 
+        <TextView
+            android:id="@+id/Documentation"
+            style="@style/Preference"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:text="@string/documentation" />
+
         <TextView
             android:id="@+id/SourceCode"
             style="@style/Preference"

app/src/main/res/values/strings.xml

@@ -126,6 +126,7 @@
     <string name="disallow_screenshots">Disallow Screenshots</string>
     <string name="discard">Discard</string>
     <string name="display_text">Text to display</string>
+    <string name="documentation">Documentation</string>
     <string name="donate">Make a Donation</string>
     <string name="drag_handle">Drag Handle</string>
     <string name="edit">Edit</string>

app/translations.xlsx

@@ -0,0 +1,142 @@
+---
+sidebar_position: 10
+---
+
+# Contributing
+
+NotallyX is an open-source project, and contributions from the community are welcome and appreciated. This guide explains how you can contribute to the project, whether you're a developer, translator, or user.
+
+## Ways to Contribute
+
+There are many ways to contribute to NotallyX, regardless of your technical skills:
+
+### For Everyone
+
+- **Report bugs**: If you find a bug, report it on [GitHub Issues](https://github.com/PhilKes/NotallyX/issues/new/choose)
+- **Suggest features**: Have an idea for a new feature? Share it on [GitHub Issues](https://github.com/PhilKes/NotallyX/issues/new/choose)
+- **Improve documentation**: Help improve this documentation by suggesting changes or additions
+- **Spread the word**: Share NotallyX with others who might find it useful
+- **Translate the app**: Help make NotallyX available in more languages, see [Contributing Translations](#Contributing-Translations)
+
+### For Developers
+
+- **Fix bugs**: Pick an open issue and submit a pull request to fix it
+- **Implement features**: Work on new features that have been approved
+- **Improve performance**: Help optimize the app's performance
+- **Write tests**: Improve test coverage to ensure reliability
+
+## Getting Started with Development
+
+If you want to contribute code to NotallyX, follow these steps:
+
+### Setting Up the Development Environment
+
+1. **Fork the repository**: Go to [NotallyX on GitHub](https://github.com/PhilKes/NotallyX) and click the "Fork" button
+2. **Clone your fork**: 
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/NotallyX.git
+   ```
+3. **Set up Android Studio**:
+   - Download and install [Android Studio](https://developer.android.com/studio)
+   - Open the cloned project in Android Studio
+   - Let Gradle sync the project dependencies
+
+4. **Configure an emulator or device**:
+   - Set up an Android emulator through AVD Manager in Android Studio, or
+   - Connect a physical Android device with USB debugging enabled
+
+### Making Changes
+
+1. **Create a new branch**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+   or
+   ```bash
+   git checkout -b fix/issue-you-are-fixing
+   ```
+
+2. **Make your changes**: Implement your feature or fix the bug
+
+3. **Follow coding standards**:
+   - Write code in Kotlin
+   - Follow the project's coding style
+   - Run `./gradlew ktfmtFormat` before committing to ensure proper formatting
+
+4. **Test your changes**:
+   - Run existing tests: `./gradlew test`
+   - Test on different Android versions if possible
+   - Ensure your changes don't break existing functionality
+
+5. **Commit your changes**:
+   ```bash
+   git add .
+   git commit -m "Brief description of your changes"
+   ```
+
+6. **Push to your fork**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+7. **Create a pull request**:
+   - Go to your fork on GitHub
+   - Click "New pull request"
+   - Select your branch and submit the pull request
+   - Provide a clear description of what your changes do
+
+## Contributing Translations
+
+To contribute translations:
+
+1. Download the current [translations.xlsx](https://github.com/PhilKes/NotallyX/raw/refs/heads/main/app/translations.xlsx) file
+2. Open it in Excel/LibreOffice and add missing translations
+   - Missing translations are marked in red
+   - You can filter by key or any language column values
+   - Non-translatable strings are hidden and marked in gray, do not add translations for them
+   - For plurals, some languages need/have more quantity strings than others
+3. Open an [Update Translations Issue](https://github.com/PhilKes/NotallyX/issues/new?assignees=&labels=translations&projects=&template=translation.md&title=%3CINSERT+LANGUAGE+HERE%3E+translations+update)
+4. The project maintainer will create a Pull Request to add your updated translations
+
+## Bug Reports and Feature Requests
+
+### Reporting Bugs
+
+When reporting a bug, please include:
+
+1. Steps to reproduce the issue
+2. What you expected to happen
+3. What actually happened
+4. Your device information (Android version, device model)
+5. Screenshots if applicable
+
+Use the bug report template when creating a new issue on GitHub.
+
+### Requesting Features
+
+When suggesting a new feature:
+
+1. Clearly describe the feature and its purpose
+2. Explain how it would benefit users
+3. Provide examples of how it might work
+4. Consider potential implementation challenges
+
+Use the feature request template when creating a new issue on GitHub.
+
+## Code of Conduct
+
+By participating in this project, you agree to maintain a respectful and inclusive environment for everyone. This includes:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+## Getting Help
+
+If you need help with contributing:
+
+- Check the [FAQ](faq.md) for common questions
+- Ask for help in the GitHub issue you're working on
+- Contact the project maintainer through GitHub

documentation/docs/contributing.md

@@ -0,0 +1,146 @@
+---
+sidebar_position: 7
+---
+
+# FAQ - Frequently Asked Questions
+
+This page answers common questions about NotallyX. If you don't find the answer you're looking for, please check the [GitHub issues](https://github.com/PhilKes/NotallyX/issues) or create a new issue.
+
+## General Questions
+
+### What is NotallyX?
+
+NotallyX is a minimalistic yet powerful note-taking app for Android. It's an extended version of the original Notally app, with additional features and improvements. The app focuses on providing a clean, intuitive interface while offering rich functionality.
+
+### Is NotallyX free?
+
+Yes, NotallyX is completely free and open-source. There are no in-app purchases, subscriptions, or advertisements.
+If you still want to donate to support me as a developer, feel free to donate via my [ko-fi link](https://ko-fi.com/philkes), it is greatly appreciated 🙂.
+
+### What devices does NotallyX support?
+
+NotallyX supports Android devices running Lollipop (Android 5.0) and above.
+
+### Where can I download NotallyX?
+
+You can download NotallyX from:
+- [Google Play Store](https://play.google.com/store/apps/details?id=com.philkes.notallyx)
+- [F-Droid](https://f-droid.org/en/packages/com.philkes.notallyx)
+- [IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/com.philkes.notallyx)
+- [GitHub Releases](https://github.com/PhilKes/NotallyX/releases)
+
+## Data and Privacy
+
+### Where are my notes stored?
+
+Your notes are stored locally on your device. NotallyX does not upload your data to any cloud service unless you explicitly use a cloud storage service to back up your notes.
+
+### Does NotallyX collect any data about me?
+
+No, NotallyX does not collect any personal data or usage statistics. Your notes remain private on your device.
+For the up-to-date privacy policy, see [Privacy-Policy](https://github.com/PhilKes/NotallyX/blob/main/Privacy-Policy.md)
+
+### What happens to my notes if I uninstall the app?
+
+If you uninstall NotallyX, your notes will be deleted unless you've created a backup. We recommend creating a backup before uninstalling the app.
+
+### Can I transfer my notes to a new device?
+
+Yes, you can use the backup and restore feature to transfer your notes to a new device:
+1. Create a backup on your old device
+2. Transfer the backup file to your new device
+3. Install NotallyX on your new device
+4. Use the import backup and settings feature to import your notes
+
+## Features and Usage
+
+### Can I sync my notes across multiple devices?
+
+NotallyX doesn't include built-in sync functionality. However, you can use third-party cloud storage services to sync your backup files across devices.
+See [Settings](./features/settings.mdx#asd)
+
+### Can I recover deleted notes?
+
+When you delete a note it first only moved into the "Deleted" notes. If you deleted notes from the "Deleted" notes they are permanently gone.
+If you've accidentally deleted a note, you can restore it from a backup if you have one. Otherwise, deleted notes cannot be recovered.
+
+### Why are my checked list items moving to the bottom?
+
+By default, NotallyX automatically sorts checked items to the bottom of lists. You can disable this feature in "Settings" > "Behavior" >  "Sort List items".
+
+### Can I use NotallyX for password storage?
+
+While you can lock the app itself, I don't recommend using NotallyX as a password manager. Dedicated password management apps offer more security features specifically designed for storing sensitive credentials.
+
+### How do I create a reminder for a note?
+
+1. Inside a Note, tap the '...' button in the bottom right corner
+2. Tap "Reminders"
+3. Select a date and time for the reminder
+4. Select if the reminder should repeated and if yes in what interval
+5. Tap "Save"
+6. When the configured point in time is reached, you will get a notification for the note
+
+### Can I change the font in notes?
+
+Currently, NotallyX uses the system font and doesn't support changing to different fonts. However, you can use change the text size in "Settings" > "Appearance" > "Text Size"
+
+## Troubleshooting
+
+### The app crashed. What should I do?
+
+If NotallyX crashes, you'll see a crash screen that allows you to report the issue directly via `Report bug with crash log`.
+If the app crashed and you did not see a crash screen:
+1. Re-open the app (if possible)
+2. From the Overview, tap the sidebar menu icon
+3. Tap "Settings" > In "About" section > "Send Feedback" > "Report an issue/bug"
+4. This will open a browser to the Github create Issue site
+5. If not already logged in, please login or create a new Github account
+6. A bug report template will be pre filled with useful information for the developers
+7. Please fill in the missing fields and provide a detailed description of how the bug/crash occurred
+
+Please use this feature to help improve the app.
+
+### My notes disappeared. How can I recover them?
+
+If your notes have disappeared, try the following:
+1. Restart the app
+2. Check if you're viewing a specific label (check the sidebar)
+3. Try searching for your notes
+4. Restore from a backup if available
+
+### Why can't I create or edit notes?
+
+This could be due to:
+1. Storage permission issues - check that NotallyX has storage permissions
+2. Storage space - ensure your device has available storage
+3. App data corruption - try clearing the app cache (not data) in your device settings
+
+### The app is slow. How can I improve performance?
+
+If you're experiencing performance issues:
+1. Reduce the number of notes by archiving or deleting unnecessary ones
+2. Disable auto-sort for checked items if you have very long lists
+3. Ensure your device has sufficient free storage
+
+## Beta Testing and Development
+
+### How can I try new features before they're released?
+
+You can join the beta program:
+1. Download the most recent BETA release [from GitHub](https://github.com/PhilKes/NotallyX/releases/tag/beta)
+2. Install the BETA version (it will be installed as a separate app called "NotallyX BETA")
+3. Provide feedback on new features
+
+#### Will the beta version affect my regular NotallyX data?
+
+No, the beta version uses a separate data store and won't affect your regular NotallyX app data.
+
+### How can I contribute to NotallyX?
+
+See our [Contribution Guidelines](contributing.md) for information on how to contribute to the project.
+
+### I found a bug. How do I report it?
+
+- From inside the app: Tap "Settings" > In "About" section > "Send Feedback" > "Report an issue/bug" (this will prefill the last crash logs and other useful information)
+- You can also report bugs directly by [creating a new issue](https://github.com/PhilKes/NotallyX/issues/new/choose) on GitHub. Please include as much detail as possible, including steps to reproduce the issue.

documentation/docs/faq.md

@@ -0,0 +1,8 @@
+{
+  "label": "Features",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Explore the features and capabilities of NotallyX."
+  }
+}