f9a328022d
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
1.7 KiB
Executable file
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 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