fix(docs): resolve markdown linting errors in all wiki files

- Add top-level headings to all wiki files (MD041)
- Fix heading spacing and blank line issues (MD022, MD012)
- Convert HTML badges to markdown format (MD033)
- Add alt text to images (MD045)
- Fix list indentation and numbering (MD005, MD029, MD032)
- Remove trailing punctuation from headings (MD026)
- Convert emphasis to proper headings (MD036)
- Fix heading level increments (MD001)
- Add trailing newlines to all files (MD047)

This ensures the wiki-sync.yml GitHub Action will pass linting.
All changes maintain the same visual appearance and functionality.

Fixes the lint failures reported in GitHub Action run #21212863659
This commit is contained in:
Johannes Millan 2026-01-21 18:03:05 +01:00
parent 05bfd96e55
commit 73c1848ba9
35 changed files with 342 additions and 253 deletions

View file

@ -1,10 +1,13 @@
# Wiki Documentation Framework
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
[[Contributing|<https://github.com/johannesjo/super-productivity#hearts-contributin>g]] to Super Productivity

View file

@ -1,31 +1,40 @@
# Wiki Structure and Organization
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-contributin>g]] to Super Productivity
[[Contributing|https://github.com/johannesjo/super-productivity#hearts-contributing]] to Super Productivity
## Planned Structure
### 1. Quickstarts (1.-Quickstarts.md)
#### Getting-Started.md
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
Can link to other How_To via anchor links.
### 2. How To (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

View file

@ -1,66 +1,74 @@
# Quickstarts
### 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
## Getting Started
- Desktop Versus Web Version
- [[Downloading Desktop App|<https://github.com/johannesjo/super-productivity#computer-downloads--instal>l]]
- [[Accessing Web Version|<https://github.com/johannesjo/super-productivity#globe_with_meridians-web-versio>n]]
- Upgrading
- Uninstalling
### [[3.-Concepts#Views]]
* The Today Page
* Timeline
* Scheduled Tasks
* Projects
* Tags
- 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
- 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
- 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
- Timers (Pomodoro and Simple)
- Break Reminders
- Idle Time Reminders
### [[3.-Concepts#Projects]]
* Customizing Project Appearance
* Notes
* Bookmarks
* Hiding Projects
- Customizing Project Appearance
- Notes
- Bookmarks
- Hiding Projects
### [[3.-Concepts#Completing-Your-Day]]
* Reflection
* Metrics
* Task Archiving
- Reflection
- Metrics
- Task Archiving
### [[3.-Concepts#Reporting]]
* Quick History
* Worklog
* Metrics
- Quick History
- Worklog
- Metrics
### [[3.-Concepts#Managing-Your-Data]]
* Importing data
* Exporting
* Syncing
* Backups
* Where Data is Stored
- Importing data
- Exporting
- Syncing
- Backups
- Where Data is Stored
### [[3.-Concepts#Integrations-with-Other-Apps]]
* Jira
* GitHub
* GitLab
* OpenProject
- Jira
- GitHub
- GitLab
- OpenProject

View file

@ -4,7 +4,8 @@
### [[1.01-First-Steps]]
Check out *Super Productivity 101* a.k.a. [[1.01-First-Steps|First Steps]] where we will teach you:
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.
@ -13,28 +14,32 @@ Check out *Super Productivity 101* a.k.a. [[1.01-First-Steps|First Steps]] where
1. [[2.08-Choose-Sync-Backend]]
2. [[2.09-Configure-Sync-Backend]]
1. WebDAV
2. Dropbox
3. Other/Custom
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`
## 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:
@ -47,4 +52,4 @@ By following these recommendations, you will be able to write a good-quality Qui
- 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 whats necessary and nothing more. Your guidance must remain focused on achieving the stated learning objective.
- Explain whats necessary and nothing more. Your guidance must remain focused on achieving the stated learning objective.

View file

@ -1,8 +1,11 @@
# First Steps
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
@ -11,4 +14,4 @@ What is covered:
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.
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.

View file

@ -1,4 +1,6 @@
### The Basics of 'Super Productivity'
# A First Steps Quick Tour
## 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.
@ -13,7 +15,7 @@ Add as many tasks as desired. There is a short-hand syntax available that is sim
![[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.
_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]]
@ -50,10 +52,8 @@ The second section is entirely subjective and help track trends of how you feel
![[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.
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.

View file

@ -1,8 +1,10 @@
# B First Steps Download And Install
See [[1.01a-First-Steps_Quick-Tour]] for the intro that precedes this.
---
### Download and Install
## Download and Install
[[1.01b-First-Steps_Download-and-Install]]
@ -10,4 +12,4 @@ Include additional guidance here as needed. It's possible to just use the Web ap
---
See [[1.01c-First-Steps_Additional-Resources]] for more.
See [[1.01c-First-Steps_Additional-Resources]] for more.

View file

@ -1,3 +1,5 @@
# C First Steps Additional Resources
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:
@ -6,4 +8,4 @@ If you make any errors, you can restore your data from backups. Refer to [[2.02-
[[1.02-Configure-Data-Synchronization]]
Example Workflows in the future such as:
[[1.00-Quickstarts#1.03 Example Workflow 1]]
[[1.00-Quickstarts#1.03 Example Workflow 1]]

View file

@ -0,0 +1 @@
# Configure Data Synchronization

View file

@ -1,3 +1,5 @@
# How-To Guides
## Downloads & Install
### All Platforms
@ -8,7 +10,7 @@
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>
[![Get it from Microsoft Store](https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png)](https://www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge)
You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
@ -23,42 +25,45 @@ choco install super-productivity
Install via command-line:
```bash
# stable
## stable
sudo snap install superproductivity
# edge channel releases
## edge channel releases
sudo snap install --channel=edge superproductivity
# it is also recommended to disable updates to the app while it is running:
## 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>
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/superproductivity)
#### Flatpak - Most distributions
### Flatpak - Most distributions
Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
Install via command-line:
```bash
# install
## install
flatpak install flathub com.super_productivity.SuperProductivity
# run
## 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>
[![Get it on Flathub](https://flathub.org/api/badge?locale=en)](https://flathub.org/apps/com.super_productivity.SuperProductivity)
#### Aur - Arch Linux
### Aur - Arch Linux
```bash
git clone https://aur.archlinux.org/superproductivity-bin.git
git clone <https://aur.archlinux.org/superproductivity-bin.git>
cd superproductivity-bin
makepkg -si
```
@ -66,7 +71,7 @@ makepkg -si
#### AppImage
If you encounter problems, please have a look here:
https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513
<https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513>
### MacOS
@ -76,11 +81,7 @@ Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
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>
[![App Store Badge](docs/screens/app-store-badge.svg)](https://apps.apple.com/de/app/super-productivity/id1482572463?l=en&mt=12)
### Android
@ -92,29 +93,20 @@ 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>
[![Google Play Badge](docs/screens/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.superproductivity.superproductivity)
[![F-Droid Badge](https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg)](https://f-droid.org/en/packages/com.superproductivity.superproductivity)
The sources can be [[../android|found here]].
#### Restore Data From Backup
##### Standard Method
###### 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**
##### 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 :))
@ -123,4 +115,4 @@ In case the app does not properly start (e.g. [inconsistent task state](https://
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
7. within SP you go to settings and import the previously located backup

View file

@ -18,6 +18,7 @@ For all platforms, you can always install [[../../releases|from the releases pag
## 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]]
@ -27,28 +28,34 @@ Include all the actions that branch out from this such as subtasks, scheduling,
### [[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`
## 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.
@ -59,4 +66,4 @@ By following these recommendations, you will be able to write good quality how-t
- 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.”
- 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.”

View file

@ -1,9 +1,11 @@
# A Download And Install 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>
[![Get it from Microsoft Store](https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png)](https://www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge)
You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
```powershell
choco install super-productivity
```
```

View file

@ -1,44 +1,49 @@
#### Snap - Most distributions
# B Download And Install Linux
## Snap - Most distributions
Install via command-line:
```bash
# stable
## stable
sudo snap install superproductivity
# edge channel releases
## edge channel releases
sudo snap install --channel=edge superproductivity
# it is also recommended to disable updates to the app while it is running:
## 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>
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/superproductivity)
#### Flatpak - Most distributions
### Flatpak - Most distributions
Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
Install via command-line:
```bash
# install
## install
flatpak install flathub com.super_productivity.SuperProductivity
# run
## 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>
[![Get it on Flathub](https://flathub.org/api/badge?locale=en)](https://flathub.org/apps/com.super_productivity.SuperProductivity)
#### Aur - Arch Linux
### Aur - Arch Linux
```bash
git clone https://aur.archlinux.org/superproductivity-bin.git
git clone <https://aur.archlinux.org/superproductivity-bin.git>
cd superproductivity-bin
makepkg -si
```
@ -46,4 +51,4 @@ makepkg -si
#### AppImage
If you encounter problems, please have a look here:
https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513
<https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513>

View file

@ -1,4 +1,6 @@
### MacOS
# C Download And Install Macos
## MacOS
Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
@ -6,8 +8,4 @@ Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
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>
[![App Store Badge](docs/screens/app-store-badge.svg)](https://apps.apple.com/de/app/super-productivity/id1482572463?l=en&mt=12)

View file

@ -1,3 +1,5 @@
# D Download And Install 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.
@ -6,17 +8,8 @@ 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>
[![Google Play Badge](docs/screens/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.superproductivity.superproductivity)
The sources can be [[../../android|found here]].
[![F-Droid Badge](https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg)](https://f-droid.org/en/packages/com.superproductivity.superproductivity)
The sources can be [[../../android|found here]].

View file

@ -1,7 +1,11 @@
**Standard Method**
# 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**
## 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 :))
@ -10,4 +14,4 @@ In case the app does not properly start (e.g. [inconsistent task state](https://
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
7. within SP you go to settings and import the previously located backup

View file

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

View file

@ -0,0 +1 @@
# Manage Subtasks

View file

@ -0,0 +1 @@
# Manage Scheduled Tasks

View file

@ -0,0 +1 @@
# Manage Repeating Tasks

View file

@ -0,0 +1 @@
# Manage Task Integrations

View file

@ -1 +1,3 @@
Stub.
# Choose Sync Backend
Stub.

View file

@ -1,3 +1,5 @@
# Configure Sync Backend
- 2.09a: WebDAV
- 2.09b: Dropbox
- 2.09c: Other/Custom
- 2.09c: Other/Custom

View file

@ -1,67 +1,74 @@
# Concepts
## Views
### Views
* The Today Page
* Timeline
* Scheduled Tasks
* Projects
* Tags
- The Today Page
- Timeline
- Scheduled Tasks
- Projects
- Tags
### Tasks
* Adding New Tasks
* Task Attributes
* Projects and Tags
* Estimating Time
* Subtasks
* Scheduled Tasks
* Repeat 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
- 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
- Timers (Pomodoro and Simple)
- Break Reminders
- Idle Time Reminders
### Projects
* Customizing Project Appearance
* Notes
* Bookmarks
* Hiding Projects
- Customizing Project Appearance
- Notes
- Bookmarks
- Hiding Projects
### Completing-Your-Day
* Reflection
* Metrics
* Task Archiving
- Reflection
- Metrics
- Task Archiving
### Reporting
* Quick History
* Worklog
* Metrics
- Quick History
- Worklog
- Metrics
### Managing-Your-Data
* Importing data
* Exporting
* Syncing
* Backups
* Where Data is Stored
- Importing data
- Exporting
- Syncing
- Backups
- Where Data is Stored
### Integrations-with-Other-Apps
* Jira
* GitHub
* GitLab
* OpenProject
- Jira
- GitHub
- GitLab
- OpenProject
### Miscellaneous
* [[Settings and Preferences]]
* [[Keyboard Shortcuts]]
* [[Upgrading]]
* [[Uninstalling]]
* [[JSON / Models]]
- [[Settings and Preferences]]
- [[Keyboard Shortcuts]]
- [[Upgrading]]
- [[Uninstalling]]
- [[JSON / Models]]

View file

@ -7,18 +7,12 @@
[[3.03-Keyboard-Shortcuts]]
[[3.04-Short-Syntax]]
# How to Write `Reference Material`
## 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.
- 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 products structure** so the user can work their way through it simultaneously. It doesnt mean forcing the documentation into an unnatural structure. Whats important is that the documentation should help make sense of the product.
- **Be consistent** in structure, language, terminology, and tone.

View file

@ -1 +1,3 @@
Undocumented.
# Api
Undocumented.

View file

@ -1,29 +1,36 @@
# Settings And Preferences
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
### global-settings.Localization
#### 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
#### global-settings.Reminders
#### global-settings.Schedule
#### global-settings.Sound
### Plugins
#### plugins.Plugins
### Productivity Helper
#### productivity-helper.Focus-Mode
@ -36,7 +43,6 @@ See [[3.03-Keyboard-Shortcuts]] for full list.
#### productivity-helper.Domina-Mode
### Sync & Export
#### sync-and-export.Sync
@ -44,4 +50,3 @@ See [[3.03-Keyboard-Shortcuts]] for full list.
#### sync-and-export.Sync-and-Export
#### sync-and-export.Sync-Safety-Backups

View file

@ -1,5 +1,7 @@
# Keyboard Shortcuts
## Global Shortcuts
### Global Shortcuts
These work everywhere in the app.
- `Shift`+`A`: Open add task bar
@ -22,6 +24,7 @@ These work everywhere in the app.
- `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
@ -47,6 +50,7 @@ The following shortcuts apply for the currently selected task (selected via tab
- `<no default binding>`: Collapse Sub Tasks
- `Y`: Toggle tracking time to currently focused task
**Unconfigurable**
#### Unconfigurable
- `Arrow keys`: Navigate around task list
- `ArrowRight`: Open additional info panel for currently focused task
- `ArrowRight`: Open additional info panel for currently focused task

View file

@ -1,11 +1,21 @@
# Short Syntax
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
- `# <tag-name>`: add a tag to the task
(`"task-description #tag1"`)
- `<number>m` or `<number>h`: set time-estimate for the task
- `<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
- `+ <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
- `Ctr + 2`: toggle between moving the new task to the bottom and top of the list

View file

@ -1,3 +1,5 @@
# Other
## 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.
@ -22,4 +24,4 @@ This will automatically apply compatibility fixes including:
- 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.
The application will automatically detect Wayland sessions and apply these fixes, but you can use this flag if automatic detection doesn't work properly.

View file

@ -1,7 +1,8 @@
# Reference
Settings and Preferences
### Keyboard-Shortcuts
## Keyboard-Shortcuts
- `Shift`+`P`: Open create project dialog
- `Shift`+`A`: Open add task bar
@ -18,21 +19,28 @@ Settings and Preferences
### Short-Syntax
Can be used when adding a task. <strong>(Each of these can be disabled in settings->short syntax)</strong>
Can be used when adding a task. **(Each of these can be disabled in settings->short syntax)**
- `# <tag-name>`: add a tag to the task
- `# <tag-name>`: add a tag to the task
(`"task-description #tag1"`)
- `<number>m` or `<number>h`: set time-estimate for the task
- `<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
- `+ <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:
@ -47,4 +55,4 @@ This will automatically apply compatibility fixes including:
- 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.
The application will automatically detect Wayland sessions and apply these fixes, but you can use this flag if automatic detection doesn't work properly.

View file

@ -1,6 +1,7 @@
# Index of `Concepts`
## Organizing
- Projects
- Tags
- Estimating Time
@ -10,10 +11,12 @@
- Estimated vs Actual Time
## Planning
- Timeline
- Scheduled Tasks
## Doing
- The Today Page
- Timers/Focus Mode
- Break Reminders
@ -23,10 +26,12 @@
## Reviewing
### Time-Tracking
- How Time is Logged
- Estimated vs Actual Time
### Completing-Your-Day
- Reflection
- Metrics
- Task Archiving
@ -40,19 +45,22 @@
- 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`
## 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.
@ -63,4 +71,4 @@ By following these recommendations, you will be able to write good quality how-t
- 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.”
- 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.”

View file

@ -1,11 +1,14 @@
## New Users: Start Here!
# Home
## 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!
## 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:
@ -13,4 +16,4 @@ The wiki is not yet set up to handle all the dev-related documentation. For now,
[[https://github.com/super-productivity/super-productivity#running-the-development-server]]
[[https://github.com/super-productivity/super-productivity#run-as-docker-container]]
[[https://github.com/super-productivity/super-productivity#run-as-docker-container]]

View file

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

View file

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