openedx / openedx/docs.openedx.org
Reorganize OLX Docs into Diataxis Framework
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
The OLX docs have been migrated from legacy docs to Open edX Docs as part of this PR: https://github.com/openedx/docs.openedx.org/pull/819
They should still be reorganized into sensible Diataxis framework. See these docs:
Diatixis Definitions: https://docs.openedx.org/en/latest/documentors/concepts/content_types.html
A holistic migration checklist (including setting the correct diataxis tag): https://docs.openedx.org/en/latest/documentors/references/doc_checklist.html
This could mean merging docs together when they serve the same diataxis purpose, splitting docs when they serve different purposes, and maintaining sensible navigation and titles through those changes.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the migrated OLX documentation from PR 819, then read the Diataxis definitions and holistic migration checklist linked in the issue. Identify documents that should be merged or split, apply sensible Diataxis categorization, and verify that titles and navigation remain coherent when the reorganization is complete.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100