Skip to content

Conversation

@sarina
Copy link
Contributor

@sarina sarina commented Jun 7, 2025

This is part of a greater docs cleanup.

Usage of :doc: is an antipattern. It is fragile and prone to breaking cross references when docs are moved or renamed.

Replace with usages of :ref:. Depends on openedx/openedx-aspects#328

@sarina sarina changed the title chore: Add references to docs to make relative, not direct, references chore: Add Aspects references to docs to make relative, not direct, references Jun 9, 2025
@sarina sarina marked this pull request as ready for review June 9, 2025 12:42
@sarina sarina requested a review from saraburns1 June 9, 2025 12:42
@sarina sarina merged commit a61bac5 into main Jun 9, 2025
2 checks passed
@sarina sarina deleted the sarina/aspects-refs-cleanup branch June 9, 2025 14:16
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

Successfully merging this pull request may close these issues.

3 participants