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/3.00-Reference.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 KiB
Executable file
Raw Permalink Blame History

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.