docs(wiki): initial revision (v0.1)

Contains both a first-draft of content as well as
a comprehensive GH Action to replicate from
docs/wiki to the `.wiki` sub-repo. The linting is
non-blocking at the moment.

- the existing markdown linking appears reliably
rendered in GH but more testing needed.
- style guide for contributions/expectations needs
to be added to the wiki
- **a significant re-work of the README** to
re-direct users to the Wiki is needed to avoid
doc duplication
- updates to the PR templates and contributor
guidelines to emphasize the importance of adding
documentation is still needed

docs/wiki/0.-Meta.md

@@ -0,0 +1,10 @@
+This Wiki is structured based on the [Diátaxis](https://diataxis.fr/) framework for documentation. A more practical description of how to implement it is found at [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#open-edx-diataxis-guide]].
+
+> [!quote]
+> The [Diataxis framework](https://diataxis.fr/) is an approach to quality in technical documentation and creates a systematic organization. Diataxis identifies four modes of documentation:
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#quickstart]]: teach you how to do something
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id2]]: tell you what to do to solve a problem or complete a task
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#reference]]: factual, static information
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#concept]]: explain the theory, context, purpose, and/or utility of something
+
+[[Contributing|https://github.com/johannesjo/super-productivity#hearts-contributing]] to Super Productivity

docs/wiki/0.00-Meta.md

@@ -0,0 +1,31 @@
+This Wiki is structured based on the [Diátaxis](https://diataxis.fr/) framework for documentation. A more practical description of how to implement it is found at [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#open-edx-diataxis-guide]].
+
+
+> The [Diataxis framework](https://diataxis.fr/) is an approach to quality in technical documentation and creates a systematic organization. Diataxis identifies four modes of documentation:
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#quickstart]]: teach you how to do something
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id2]]: tell you what to do to solve a problem or complete a task
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#reference]]: factual, static information
+> - [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#concept]]: explain the theory, context, purpose, and/or utility of something
+
+
+[[Contributing|https://github.com/johannesjo/super-productivity#hearts-contributing]] to Super Productivity
+
+
+
+1.-Quickstarts.md
+	## Getting-Started.md
+		Can link to other How_To via anchor links.
+2.-How_To.md
+	Download Instructions
+	Create Tasks and all other relevant Guides from the dev.to guide
+	Contribute to the Wiki (describe the basic structure and principles, etc. and then styling)
+3. Concepts
+	- What is a concept? Answers a question.
+	  Make connections to other things.
+	  Provide background and context.
+	  (About) Topic should be implicit.
+4. Reference
+	- Keyboard Shortcuts
+	- User Data Location
+	- Known Incompatibilities?
+	- API

docs/wiki/1.-Quickstarts.md

@@ -0,0 +1,66 @@
+
+### Getting Started
+* Desktop Versus Web Version
+* [[Downloading Desktop App|https://github.com/johannesjo/super-productivity#computer-downloads--install]]
+* [[Accessing Web Version|https://github.com/johannesjo/super-productivity#globe_with_meridians-web-version]]
+* Upgrading
+* Uninstalling
+
+### [[3.-Concepts#Views]]
+* The Today Page
+* Timeline
+* Scheduled Tasks
+* Projects
+* Tags
+
+### [[3.-Concepts#Tasks]]
+
+* Adding New Tasks
+* Task Attributes
+* Projects and Tags
+* Estimating Time
+* Subtasks
+* Scheduled Tasks
+* Repeat Tasks
+
+### [[3.-Concepts#Time-Tracking]]
+* Starting the Task
+* How Time is Logged
+* Marking Tasks Complete
+* Estimated vs Actual Time
+
+### [[3.-Concepts#Productivity-Helpers]]
+* Timers (Pomodoro and Simple)
+* Break Reminders
+* Idle Time Reminders
+
+### [[3.-Concepts#Projects]]
+* Customizing Project Appearance
+* Notes
+* Bookmarks
+* Hiding Projects
+
+### [[3.-Concepts#Completing-Your-Day]]
+* Reflection
+* Metrics
+* Task Archiving
+
+### [[3.-Concepts#Reporting]]
+* Quick History
+* Worklog
+* Metrics
+
+### [[3.-Concepts#Managing-Your-Data]]
+* Importing data
+* Exporting
+* Syncing
+* Backups
+* Where Data is Stored
+
+### [[3.-Concepts#Integrations-with-Other-Apps]]
+* Jira
+* GitHub
+* GitLab
+* OpenProject
+
+

docs/wiki/1.00-Quickstarts.md

@@ -0,0 +1,50 @@
+# Index of `Quickstart` Guides
+
+## Uncategorized
+
+### [[1.01-First-Steps]]
+
+Check out *Super Productivity 101* a.k.a. [[1.01-First-Steps|First Steps]] where we will teach you:
+- how to use Super Productivity in the web app.
+- how to install the desktop or mobile app.
+- how to find other resources once you are done with the basics.
+
+### [[1.02-Configure-Data-Synchronization]]
+
+1. [[2.08-Choose-Sync-Backend]]
+2. [[2.09-Configure-Sync-Backend]]
+	1. WebDAV
+	2. Dropbox
+	3. Other/Custom
+3. Tweak the Settings in [[3.02-Settings-and-Preferences#sync-and-export.Sync-and-Export]]
+4. Ensure data safety by knowing how to [[2.02-Restore-Data-From-Backup]]
+
+### 1.03 Example Workflow 1
+- settings used
+- project and/or tag usage and naming
+- time tracking and focus mode usage
+
+### 1.45 Example Workflow 2
+- settings used
+- project and/or tag usage and naming
+- time tracking and focus mode usage
+
+### 1.34 Example Workflow 3
+- settings used
+- project and/or tag usage and naming
+- time tracking and focus mode usage
+
+# How to Write `Quickstarts`
+The `1.XX` sections should strive to follow these [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#technical-guidelines]].
+
+By following these recommendations, you will be able to write a good-quality Quickstart:
+
+- Add the Quickstart to the title to guide the reader.
+- Teach by doing.
+- Use a friendly and professional tone.
+- The learning objective should be apparent from the beginning. Setting expectations from the start allows the learners to see themselves building towards the completed goal as they work.
+- Do not omit the “obvious.” Your learners follow the quickstart because they do not know about that topic or product.
+- Every step the learner follows should produce an understandable result, however small.
+- Your Quickstart should work for all users every time. This means you must consider different types of devices and software and test your Quickstart once a year to ensure it is updated.
+- Be specific about actions and outcomes.
+- Explain what’s necessary and nothing more. Your guidance must remain focused on achieving the stated learning objective.

docs/wiki/1.01-First-Steps.md

@@ -0,0 +1,14 @@
+Welcome!
+This series of notes will get you up and running right away so you can see if Super Productivity works for you.
+
+First, walk through the most basic tasks in the Web-version of the App in [[1.01a-First-Steps_Quick-Tour]].
+What is covered:
+- adding tasks
+- editing tasks
+- deleting tasks
+- using the time tracker
+- Sync settings and their importance
+
+If you are ready to move up to the Desktop version take a look at [[1.01b-First-Steps_Download-and-Install]].
+
+With the basics sorted out you will likely want to start doing *more*. [[1.01c-First-Steps_Additional-Resources]] will help direct you to solve specific problems or answer questions.

docs/wiki/1.01a-First-Steps_Quick-Tour.md

@@ -0,0 +1,59 @@
+### The Basics of 'Super Productivity'
+
+Open the [Web App](https://app.super-productivity.com/). This doesn't contain all the features or capabilities of the desktop version but it's more than enough to get started.
+
+There is an interactive tour that will greet you at first. These notes follow this tour closely.
+![[assets/1.01-First-Steps-welcome.png]]
+
+Use the "+" button in the top right or the keyboard shortcut `Shift+A` to do so.
+
+![[assets/1.01-First-Steps-create-task.png]]
+
+Add as many tasks as desired. There is a short-hand syntax available that is similar to many other task managers. Press 'Escape' or click outside the task overlay when done.
+
+![[assets/1.01-First-Steps-finish-task-creation.png]]
+
+*Super Productivity* integrates time tracking as a core feature. It is easy to remove or add time usage later if the idea of a running stopwatch adds too much pressure. Starting and stopping can be done at anytime no matter where you are in the app.
+
+![[assets/1.01-First-Steps-start-time-tracking.png]]
+
+![[assets/1.01-First-Steps-pause-time-tracking.png]]
+
+For any task in the list, you can open a side panel to edit details any details associated with it.
+
+![[assets/1.01-First-Steps-task-details.png]]
+
+![[assets/1.01-First-Steps-task-details-1.png]]
+
+To delete a task, right click on it to open it up and the "Delete Task" button will be at the bottom. 'Backspace' will accomplish the same thing if the task is selected.
+
+![[assets/1.01-First-Steps-delete-task.png]]
+
+Continue with the Quick Tour to see the other areas such as Projects and Issues. Open up Settings.
+
+![[assets/1.01-First-Steps-settings-sync-1.png]]
+
+The Web App is limited to your browser on a single computer at first. Later on if you find that Super Productivity works well for you it is very likely you will want to configure "Syncing". Even if you only use a single computer, using "Sync" will ensure that all your data is saved reliably. We can ignore "Sync Settings" for now.
+
+![[assets/1.01-First-Steps-settings-sync-2.png]]
+
+---
+
+The Quick Tour doesn't cover this next part but it will eventually come up. On the main "Today" view that we have been looking at there is a "Finish Day" button:
+![[assets/1.01-First-Steps-finish-day-0.png]]
+
+This will move your completed tasks to the "Archive" and present you with an End-of-Day report for you to review. The first section sums your time tracked compared to your time estimates.
+
+![[assets/1.01-First-Steps-finish-day-1.png]]
+
+The second section is entirely subjective and help track trends of how you feel while working.
+
+![[assets/1.01-First-Steps-finish-day-2.png]]
+
+
+---
+
+That's it! *Super Productivity* is still undergoing rapid development and supports a wide variety of working styles. With flexibility comes complexity... so focus on the basics of adding and managing tasks and learning to work with the time tracker for now. There are many options and ways to configure the app to accommodate you when that time comes.
+
+See [[1.01b-First-Steps_Download-and-Install]] for more.
+

docs/wiki/1.01b-First-Steps_Download-and-Install.md

@@ -0,0 +1,13 @@
+See [[1.01a-First-Steps_Quick-Tour]] for the intro that precedes this.
+
+---
+
+### Download and Install
+
+[[1.01b-First-Steps_Download-and-Install]]
+
+Include additional guidance here as needed. It's possible to just use the Web app version too.
+
+---
+
+See [[1.01c-First-Steps_Additional-Resources]] for more.

docs/wiki/1.01c-First-Steps_Additional-Resources.md

@@ -0,0 +1,9 @@
+If you make any errors, you can restore your data from backups. Refer to [[2.02-Restore-Data-From-Backup]].
+
+!TODO: Describe some of these in more detail:
+![[assets/1.01c-First-Steps_Additional-Resources-app-help.png]]
+
+[[1.02-Configure-Data-Synchronization]]
+
+Example Workflows in the future such as:
+[[1.00-Quickstarts#1.03 Example Workflow 1]]

docs/wiki/2.-How_To.md

@@ -0,0 +1,126 @@
+## Downloads & Install
+
+### All Platforms
+
+[[../releases|Install from the releases page]].
+
+### Windows
+
+Due to certification issues it's recommended to download the app from the Microsoft Store:
+
+<a href='//www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge'><img src='https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png' alt='English badge' width="127" height="52"/></a>
+
+You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
+
+```powershell
+choco install super-productivity
+```
+
+### Linux
+
+#### Snap - Most distributions
+
+Install via command-line:
+
+```bash
+# stable
+sudo snap install superproductivity
+
+# edge channel releases
+sudo snap install --channel=edge superproductivity
+
+# it is also recommended to disable updates to the app while it is running:
+sudo snap set core experimental.refresh-app-awareness=true
+```
+
+<a href="https://snapcraft.io/superproductivity">
+  <img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
+</a>
+
+#### Flatpak - Most distributions
+
+Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
+
+Install via command-line:
+
+```bash
+# install
+flatpak install flathub com.super_productivity.SuperProductivity
+
+# run
+flatpak run com.super_productivity.SuperProductivity
+```
+
+<a href='https://flathub.org/apps/com.super_productivity.SuperProductivity'>
+    <img width='175' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
+  </a>
+
+#### Aur - Arch Linux
+
+```bash
+git clone https://aur.archlinux.org/superproductivity-bin.git
+cd superproductivity-bin
+makepkg -si
+```
+
+#### AppImage
+
+If you encounter problems, please have a look here:
+https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513
+
+### MacOS
+
+Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
+
+```bash
+brew install --cask superproductivity
+```
+
+<a href='//apps.apple.com/de/app/super-productivity/id1482572463?l=en&mt=12' target="_blank">
+  <img src='docs/screens/app-store-badge.svg'
+       alt='App Store Badge'
+       height="50" />
+</a>
+
+### Android
+
+A new version of the Android app is now available with **Connectivity-Free Mode**, allowing you to use the app without an internet connection.
+
+This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you're online or offline.
+
+Stay tuned for even more exciting updates!
+
+You can find the Android app here:
+
+<a href='//play.google.com/store/apps/details?id=com.superproductivity.superproductivity' target="_blank">
+  <img src='docs/screens/google-play-badge.png'
+       align="center"
+       alt='App Store Badge'
+       height="50" />
+</a>
+<a href='//f-droid.org/en/packages/com.superproductivity.superproductivity' target="_blank">
+  <img src='https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg'
+       align="center"
+       alt='F-Droid Badge'
+       height="50" />
+</a>
+
+The sources can be [[../android|found here]].
+
+
+
+###### Restore Data From Backup
+
+**Standard Method**
+The backup path should be shown under settings and then "Automatic Backups". You can then import the backup under "Import / Export".
+
+**Alternative Method: Pre-Clearing Application**
+In case the app does not properly start (e.g. [inconsistent task state](https://github.com/johannesjo/super-productivity/issues/3052)), the data must be cleared first:
+
+1. locate the backup and possibly make another copy of it (not strictly necessary, but can't hurt :))
+2. start the app
+3. hit strg+shift+i to open the dev tools
+4. go to application/storage
+5. hit clear site data
+6. hit strg+r to reload the app
+7. within SP you go to settings and import the previously located backup

docs/wiki/2.00-How_To.md

@@ -0,0 +1,62 @@
+# Index of `How To` Guides
+
+## Setup and Configuration
+
+### 2.01-Download-and-Install
+
+- [[2.01a-Download-and-Install_Windows|Windows]]
+- [[2.01b-Download-and-Install_Linux|Linux]]
+- [[2.01c-Download-and-Install_MacOS|MacOS]]
+- [[2.01d-Download-and-Install_Android|Android]]
+
+For all platforms, you can always install [[../../releases|from the releases page]] if you prefer.
+
+### [[2.02-Restore-Data-From-Backup]]
+
+### Adjust Common Settings (?)
+
+## Tasks
+
+### [[2.03-Add-Tasks]]
+Include all the actions that branch out from this such as subtasks, scheduling, repetition, and integrations via [[4.00-Concepts#Integrations-with-Other-Apps]].
+
+### [[2.04-Manage-Subtasks]]
+
+### [[2.05-Manage-Scheduled-Tasks]]
+
+### [[2.06-Manage-Repeating-Tasks]]
+
+Time-Tracking
+- Starting the Task
+- Marking Tasks Complete
+- Estimated vs Actual Time
+
+Projects and Tags
+- Customizing Project Appearance
+- Hiding Projects
+- Use Tags
+
+Complete the Day
+- How to Complete the Day
+
+Managing Your Data
+- Importing data
+- Exporting
+- Syncing
+- [[2.02-Restore-Data-From-Backup]]
+
+Integrations
+- How to configure for each
+
+# How to Write a `How To`
+The `2.XX` sections should strive to follow these [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id3]].
+
+There is an assumed "How to..." preceding `2.XX` note titles.
+
+By following these recommendations, you will be able to write good quality how-to guides:
+
+- Describe a sequence of actions. A how-to guide contains a sequence of actions that have an order.
+- Solve a particular task. The problem or task is the concern of a how-to guide: stick to that practical goal.
+- Do not explain concepts—link to other documents for further explanation.
+- Omit the unnecessary. Practical usability is more helpful than completeness.
+- Pay attention to naming. Choose action-based titles that say precisely what the how-to guide shows, such as “Import A Course” or “Copy And Paste Course Content.”

docs/wiki/2.01a-Download-and-Install_Windows.md

@@ -0,0 +1,9 @@
+Due to certification issues it's recommended to download the app from the Microsoft Store:
+
+<a href='//www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge'><img src='https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png' alt='English badge' width="127" height="52"/></a>
+
+You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
+
+```powershell
+choco install super-productivity
+```

docs/wiki/2.01b-Download-and-Install_Linux.md

@@ -0,0 +1,49 @@
+#### Snap - Most distributions
+
+Install via command-line:
+
+```bash
+# stable
+sudo snap install superproductivity
+
+# edge channel releases
+sudo snap install --channel=edge superproductivity
+
+# it is also recommended to disable updates to the app while it is running:
+sudo snap set core experimental.refresh-app-awareness=true
+```
+
+<a href="https://snapcraft.io/superproductivity">
+  <img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
+</a>
+
+#### Flatpak - Most distributions
+
+Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
+
+Install via command-line:
+
+```bash
+# install
+flatpak install flathub com.super_productivity.SuperProductivity
+
+# run
+flatpak run com.super_productivity.SuperProductivity
+```
+
+<a href='https://flathub.org/apps/com.super_productivity.SuperProductivity'>
+    <img width='175' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
+  </a>
+
+#### Aur - Arch Linux
+
+```bash
+git clone https://aur.archlinux.org/superproductivity-bin.git
+cd superproductivity-bin
+makepkg -si
+```
+
+#### AppImage
+
+If you encounter problems, please have a look here:
+https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513

docs/wiki/2.01c-Download-and-Install_MacOS.md

@@ -0,0 +1,13 @@
+### MacOS
+
+Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
+
+```bash
+brew install --cask superproductivity
+```
+
+<a href='//apps.apple.com/de/app/super-productivity/id1482572463?l=en&mt=12' target="_blank">
+  <img src='docs/screens/app-store-badge.svg'
+       alt='App Store Badge'
+       height="50" />
+</a>

docs/wiki/2.01d-Download-and-Install_Android.md

@@ -0,0 +1,22 @@
+A new version of the Android app is now available with **Connectivity-Free Mode**, allowing you to use the app without an internet connection.
+
+This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you're online or offline.
+
+Stay tuned for even more exciting updates!
+
+You can find the Android app here:
+
+<a href='//play.google.com/store/apps/details?id=com.superproductivity.superproductivity' target="_blank">
+  <img src='docs/screens/google-play-badge.png'
+       align="center"
+       alt='App Store Badge'
+       height="50" />
+</a>
+<a href='//f-droid.org/en/packages/com.superproductivity.superproductivity' target="_blank">
+  <img src='https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg'
+       align="center"
+       alt='F-Droid Badge'
+       height="50" />
+</a>
+
+The sources can be [[../../android|found here]].

docs/wiki/2.02-Restore-Data-From-Backup.md

@@ -0,0 +1,13 @@
+**Standard Method**
+The backup path should be shown under settings and then "Automatic Backups". You can then import the backup under "Import / Export".
+
+**Alternative Method: Pre-Clearing Application**
+In case the app does not properly start (e.g. [inconsistent task state](https://github.com/johannesjo/super-productivity/issues/3052)), the data must be cleared first:
+
+1. locate the backup and possibly make another copy of it (not strictly necessary, but can't hurt :))
+2. start the app
+3. hit strg+shift+i to open the dev tools
+4. go to application/storage
+5. hit clear site data
+6. hit strg+r to reload the app
+7. within SP you go to settings and import the previously located backup

docs/wiki/2.03-Add-Tasks.md

@@ -0,0 +1,6 @@
+
+
+[[2.04-Manage-Subtasks]]
+[[2.05-Manage-Scheduled-Tasks]]
+[[2.06-Manage-Repeating-Tasks]]
+[[2.07-Manage-Task-Integrations]]

docs/wiki/2.08-Choose-Sync-Backend.md

@@ -0,0 +1 @@
+Stub.

docs/wiki/2.09-Configure-Sync-Backend.md

@@ -0,0 +1,3 @@
+- 2.09a: WebDAV
+- 2.09b: Dropbox
+- 2.09c: Other/Custom

docs/wiki/3.-Concepts.md

@@ -0,0 +1,67 @@
+
+
+
+
+### Views
+* The Today Page
+* Timeline
+* Scheduled Tasks
+* Projects
+* Tags
+
+### Tasks
+* Adding New Tasks
+* Task Attributes
+* Projects and Tags
+* Estimating Time
+* Subtasks
+* Scheduled Tasks
+* Repeat Tasks
+
+### Time-Tracking
+* Starting the Task
+* How Time is Logged
+* Marking Tasks Complete
+* Estimated vs Actual Time
+
+### Productivity-Helpers
+* Timers (Pomodoro and Simple)
+* Break Reminders
+* Idle Time Reminders
+
+### Projects
+* Customizing Project Appearance
+* Notes
+* Bookmarks
+* Hiding Projects
+
+### Completing-Your-Day
+* Reflection
+* Metrics
+* Task Archiving
+
+### Reporting
+* Quick History
+* Worklog
+* Metrics
+
+### Managing-Your-Data
+* Importing data
+* Exporting
+* Syncing
+* Backups
+* Where Data is Stored
+
+### Integrations-with-Other-Apps
+* Jira
+* GitHub
+* GitLab
+* OpenProject
+
+### Miscellaneous
+* [[Settings and Preferences]]
+* [[Keyboard Shortcuts]]
+* [[Upgrading]] 
+* [[Uninstalling]]
+* [[JSON / Models]]
+

docs/wiki/3.00-Reference.md

@@ -0,0 +1,24 @@
+# Index of `Reference Material`
+
+## Uncategorized
+
+[[3.01-API]]
+[[3.02-Settings-and-Preferences]]
+[[3.03-Keyboard-Shortcuts]]
+[[3.04-Short-Syntax]]
+
+# How to Write `Reference Material`
+The `3.XX` sections should strive to follow these [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id5]].
+
+- Do nothing but describe. References have one job: **to explain** and do that **accurately and comprehensively**.    
+- **Be accurate.** These descriptions must be accurate and kept up-to-date.    
+- **Provide examples.** It is a valuable way of providing illustrations that help readers understand the references without becoming distracted from the job of describing them.    
+- **The documentation structure should mirror the product’s structure** so the user can work their way through it simultaneously. It doesn’t mean forcing the documentation into an unnatural structure. What’s important is that the documentation should help make sense of the product.
+- **Be consistent** in structure, language, terminology, and tone.
+
+
+
+
+
+
+

docs/wiki/3.01-API.md

@@ -0,0 +1 @@
+Undocumented.

docs/wiki/3.02-Settings-and-Preferences.md

@@ -0,0 +1,47 @@
+Note: All settings will be shown with the default values.
+Note: Differences between the Web app and the Desktop app will be specified.
+
+### Global Settings
+
+#### global-settings.Localization
+#### global-settings.App-Features
+#### global-settings.Misc-Settings
+#### global-settings.Short-Syntax
+#### global-settings.Idle-Handling
+#### global-settings.Keyboard-Shortcuts
+
+See [[3.03-Keyboard-Shortcuts]] for full list.
+
+#### global-settings.Time-Tracking
+#### global-settings.Reminders
+#### global-settings.Schedule
+#### global-settings.Sound
+
+
+### Plugins
+
+#### plugins.Plugins
+
+
+
+### Productivity Helper
+
+#### productivity-helper.Focus-Mode
+
+#### productivity-helper.Break-Reminder
+
+#### productivity-helper.Evaluation-and-Metrics
+
+#### productivity-helper.Simple-Counters-and-Habit-Tracking
+
+#### productivity-helper.Domina-Mode
+
+
+### Sync & Export
+
+#### sync-and-export.Sync
+
+#### sync-and-export.Sync-and-Export
+
+#### sync-and-export.Sync-Safety-Backups
+

docs/wiki/3.03-Keyboard-Shortcuts.md

@@ -0,0 +1,52 @@
+
+### Global Shortcuts
+These work everywhere in the app.
+
+- `Shift`+`A`: Open add task bar
+- `Shift`+`P`: Open create project dialog
+- `N`: Add new note
+- `Shift+D`: Focus Sidenav
+- `Shift+N`: Show/Hide Notes
+- `C`: Toggle Filter/Group/Sort Panel
+- `P`: Show/Hide Issue Panel
+- `Shift`+`F`: Show search bar
+- `B`: Show/Hide Task Backlog
+- `W`: Go to Work View and focus first task
+- `F`: Enter Focus Mode
+- `Shift`+`T`: Go to Schedule
+- `Shift`+`S`: Go to scheduled Tasks
+- `<no default binding>`: Go to Settings
+- `Ctrl`+`=`: Zoom in (Desktop/Firefox/Chrome)
+- `Ctrl`+`-`: Zoom in (Desktop/Firefox/Chrome)
+- `Ctrl`+`0` (zero): Zoom default (Desktop/Firefox/Chrome)
+- `Ctrl`+`S`: Trigger sync (if configured)
+
+### Tasks
+The following shortcuts apply for the currently selected task (selected via tab or mouse).
+
+- `<no default binding>`: Edit Title
+- `I`: Show/Hide additional task info
+- `T`: Edit estimation / time spent
+- `S`: Open schedule dialog for currently focused task
+- `D`: Mark currently focused task as done
+- `A`: Add subtask to currently focused task
+- `L`: Attach file or link
+- `Enter`: Edit currently focused task title
+- `Backspace`: Delete currently focused task
+- `E`: Open move task to project menu
+- `Q`: Open task context menu
+- `K`: Select previous Task
+- `J`: Select next Task
+- `Ctrl`+`Shift`+`ArrowUp`: Move currently focused task up in list
+- `Ctrl`+`Shift`+`ArrowDown`: Move currently focused task down in list
+- `Ctrl`+`Alt`+`ArrowUp`: Move currently focused task to the top
+- `Ctrl`+`Alt`+`ArrowDown`: Move currently focused task down to the bottom
+- `Shift`+`B`: Move Task to Task Backlog
+- `Shift`+`T`: Move Task to Today's Task List
+- `<no default binding>`: Expand Sub Tasks
+- `<no default binding>`: Collapse Sub Tasks
+- `Y`: Toggle tracking time to currently focused task
+
+**Unconfigurable**
+- `Arrow keys`: Navigate around task list
+- `ArrowRight`: Open additional info panel for currently focused task

docs/wiki/3.04-Short-Syntax.md

@@ -0,0 +1,11 @@
+Can be used when adding a task. Each of these can be disabled in [[3.02-Settings-and-Preferences#global-settings.Short-Syntax]].
+
+- `# <tag-name>`: add a tag to the task  
+  (`"task-description #tag1"`)
+- `<number>m` or `<number>h`: set time-estimate for the task  
+  (`"task-description 10m"` or `"task-description 5h"`)
+- `@<time>`: add due time to the task
+  (`"task-description @fri 10pm"`)
+- `+ <project-name>`: add the task to an existing project  
+  (`"task-description +Important Project"`)
+- `Ctr + 2`: toggle between moving the new task to the bottom and top of the list

docs/wiki/3.99-Other.md

@@ -0,0 +1,25 @@
+## Web-App-Limitations
+
+Time tracking only works if the app is open and for idle time tracking to work, the chrome extension must be installed.
+
+If you want the Jira integration and idle time tracking to work, you also have to download and install the [Super Productivity Chrome Extension](https://chrome.google.com/webstore/detail/super-productivity/ljkbjodfmekklcoibdnhahlaalhihmlb).
+
+### JSON-Models
+
+Placeholder.
+
+### Wayland-Compatibility
+
+If you're experiencing issues running Super Productivity on Wayland (such as rendering problems, VSync errors, or GLib-GObject warnings), you can force the application to use X11 mode by starting it with the `--force-x11` parameter:
+
+```bash
+superproductivity --force-x11
+```
+
+This will automatically apply compatibility fixes including:
+
+- Forcing the Ozone platform to use X11 instead of Wayland
+- Disabling GPU VSync to prevent GetVSyncParametersIfAvailable() errors
+- Setting the appropriate environment variables for X11 compatibility
+
+The application will automatically detect Wayland sessions and apply these fixes, but you can use this flag if automatic detection doesn't work properly.

docs/wiki/4.-Reference.md

@@ -0,0 +1,50 @@
+
+Settings and Preferences
+
+### Keyboard-Shortcuts
+
+- `Shift`+`P`: Open create project dialog
+- `Shift`+`A`: Open add task bar
+- `Enter`: Edit currently focussed task title
+- `Arrow keys`: Navigate around task list
+- `D`: Mark currently focused task as done
+- `A`: Add subtask to currently focused task
+- `Y`: Toggle tracking time to currently focused task
+- `S`: Open schedule dialog for currently focused task
+- `Backspace`: Delete currently focused task
+- `ArrowRight`: Open additional info panel for currently focused task
+- `Ctrl`+`Shift`+`ArrowUp`: Move currently focused task up in list
+- `Ctrl`+`Shift`+`ArrowDown`: Move currently focused task down in list
+
+### Short-Syntax
+
+Can be used when adding a task. <strong>(Each of these can be disabled in settings->short syntax)</strong>
+
+- `# <tag-name>`: add a tag to the task  
+  (`"task-description #tag1"`)
+- `<number>m` or `<number>h`: set time-estimate for the task  
+  (`"task-description 10m"` or `"task-description 5h"`)
+- `@<time>`: add due time to the task
+  (`"task-description @fri 10pm"`)
+- `+ <project-name>`: add the task to an existing project  
+  (`"task-description +Important Project"`)
+- `Ctr + 2`: toggle between moving the new task to the bottom and top of the list
+
+### JSON-Models
+
+
+### Wayland-Compatibility
+
+If you're experiencing issues running Super Productivity on Wayland (such as rendering problems, VSync errors, or GLib-GObject warnings), you can force the application to use X11 mode by starting it with the `--force-x11` parameter:
+
+```bash
+superproductivity --force-x11
+```
+
+This will automatically apply compatibility fixes including:
+
+- Forcing the Ozone platform to use X11 instead of Wayland
+- Disabling GPU VSync to prevent GetVSyncParametersIfAvailable() errors
+- Setting the appropriate environment variables for X11 compatibility
+
+The application will automatically detect Wayland sessions and apply these fixes, but you can use this flag if automatic detection doesn't work properly.

docs/wiki/4.00-Concepts.md

@@ -0,0 +1,66 @@
+# Index of `Concepts`
+
+## Organizing
+- Projects
+- Tags
+- Estimating Time
+- Task Attributes
+- Notes
+- Bookmarks
+- Estimated vs Actual Time
+
+## Planning
+- Timeline
+- Scheduled Tasks
+
+## Doing
+- The Today Page
+- Timers/Focus Mode
+- Break Reminders
+- Idle Time Reminders
+- Estimated vs Actual Time
+
+## Reviewing
+
+### Time-Tracking
+- How Time is Logged
+- Estimated vs Actual Time
+
+### Completing-Your-Day
+- Reflection
+- Metrics
+- Task Archiving
+- Quick History
+- Worklog
+
+## Managing-Your-Data
+
+- Sync (general)
+- Backups
+- Where Data is Stored
+
+## Integrations-with-Other-Apps
+- Jira
+- GitHub
+- GitLab
+- OpenProject
+
+### Miscellaneous
+- [[3.02-Settings-and-Preferences]]
+- [[3.03-Keyboard-Shortcuts]]
+- Upgrading
+- Uninstalling
+- [[3.99-Other#JSON-Models]]
+
+# How to Write a `Concept`
+The `4.XX` sections should strive to follow these [[https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id7]].
+
+There is an assumed "About..." preceding `4.XX` note titles.
+
+By following these recommendations, you will be able to write good quality how-to guides:
+
+- Describe a sequence of actions. A how-to guide contains a sequence of actions that have an order.
+- Solve a particular task. The problem or task is the concern of a how-to guide: stick to that practical goal.
+- Do not explain concepts—link to other documents for further explanation.
+- Omit the unnecessary. Practical usability is more helpful than completeness.
+- Pay attention to naming. Choose action-based titles that say precisely what the how-to guide shows, such as “Import A Course” or “Copy And Paste Course Content.”

docs/wiki/Home.md

@@ -0,0 +1,16 @@
+## New Users: Start Here!
+
+Check out [[1.01-First-Steps]] where we will teach you:
+- how to use Super Productivity in the web app.
+- how to install the desktop or mobile app.
+- how to find other resources once you are done with the basics.
+
+## Devs & Contributors: Start Here!
+
+The wiki is not yet set up to handle all the dev-related documentation. For now, here are some relevant links to sections within the README:
+
+[[https://github.com/super-productivity/super-productivity#community]]
+
+[[https://github.com/super-productivity/super-productivity#running-the-development-server]]
+
+[[https://github.com/super-productivity/super-productivity#run-as-docker-container]]

docs/wiki/_Footer.md

@@ -0,0 +1 @@
+Footer. Any valid markdown can go here.

docs/wiki/_Sidebar.md

@@ -0,0 +1 @@
+Sidebar. Any valid markdown can go here.