Skip to content

Internal link for Backward Compatibility Policy #499

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mozaffar
Copy link

@mozaffar mozaffar commented Aug 15, 2025

User description

Added: Internal link for Backward Compatibility Policy


PR Type

Documentation


Description

  • Added internal link to Backward Compatibility Policy

File Walkthrough

Relevant files
Documentation
index.md
Added internal link to policy document                                     

versioned_docs/version-5.3/development-strategy/index.md

  • Added markdown link to "Backward Compatibility Policy" text
  • Link points to internal documentation URL
+1/-1     

Added: Internal link for Backward Compatibility Policy
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Link Target

Verify that the linked URL is correct for the versioned docs and should point to an internal relative path instead of an absolute external URL, to keep links working across versions and in offline builds.

* A release is said to be "backward compatible" with an earlier release if your system continues to work correctly when updated to that release even when other parts of your system were not updated at the same time. However, there are limits to what is covered by backward compatibility and you should read the [Backward Compatibility Policy](https://manual.joomla.org/docs/development-strategy/backward-compatibility-policy/) for the full details.
* A major release is the only kind of release where backward compatibility can be intentionally broken. A minor release may add new features and capabilities but it must be backward compatible with the release it replaces. Patch releases are for bug and security fixes only and will not break backward compatibility. A needed security fix can break backward compatibility of any kind of release.

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Use internal relative link

Replace the absolute external URL with a relative internal link to avoid broken
links across environments and versioned docs. Use a site-relative path that
Docusaurus/Docs tooling can rewrite correctly for different versions.

versioned_docs/version-5.3/development-strategy/index.md [30]

-* A release is said to be "backward compatible" with an earlier release if your system continues to work correctly when updated to that release even when other parts of your system were not updated at the same time. However, there are limits to what is covered by backward compatibility and you should read the [Backward Compatibility Policy](https://manual.joomla.org/docs/development-strategy/backward-compatibility-policy/) for the full details.
+* A release is said to be "backward compatible" with an earlier release if your system continues to work correctly when updated to that release even when other parts of your system were not updated at the same time. However, there are limits to what is covered by backward compatibility and you should read the [Backward Compatibility Policy](/docs/development-strategy/backward-compatibility-policy/) for the full details.
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly recommends using a relative path for an internal link, which improves the documentation's maintainability and robustness across different versions and environments.

Low
  • More

@HLeithner
Copy link
Member

please use the markdown file as link and not a absolute url. thanks

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

Successfully merging this pull request may close these issues.

2 participants