Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-01-23 02:36:05 +00:00
Code Issues Projects Releases Wiki Activity
super-productivity/docs/wiki/2.00-How_To.md
Johannes Millan 73c1848ba9 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
2026-01-21 18:03:05 +01:00

1.9 KiB
Executable file
Raw Permalink Blame History

Index of How To Guides

Setup and Configuration

2.01-Download-and-Install

For all platforms, you can always install ../../releases 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

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.”