mirror of
https://github.com/johannesjo/super-productivity.git
synced 2026-01-23 02:36:05 +00:00
73c1848ba9
- 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
1.8 KiB
Executable file
1.8 KiB
Executable file
Wiki Structure and Organization
This Wiki is structured based on the Diátaxis 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 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
Planned Structure
1. Quickstarts (1.-Quickstarts.md)
Getting-Started.md
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