Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize OLX Docs into Diataxis Framework #825

Open
jswope00 opened this issue Feb 13, 2025 · 1 comment
Open

Reorganize OLX Docs into Diataxis Framework #825

jswope00 opened this issue Feb 13, 2025 · 1 comment

Comments

@jswope00
Copy link
Contributor

The OLX docs have been migrated from legacy docs to Open edX Docs as part of this PR: #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.

@sarina
Copy link
Contributor

sarina commented Mar 3, 2025

OLX documents are linked to in myriad places. For redirect purposes it might be nice to not fully delete a given page (including renaming) but instead leave the page as a stub with just a seealso to the diataxis pages.

The pages can be included in a :hidden: toctree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants