Skip to content

fix(eslint-plugin-fiori-tools): fix broken documentation links in rule docs#4417

Open
Xyerophyte wants to merge 2 commits intoSAP:mainfrom
Xyerophyte:fix/broken-doc-links-eslint-plugin-4219
Open

fix(eslint-plugin-fiori-tools): fix broken documentation links in rule docs#4417
Xyerophyte wants to merge 2 commits intoSAP:mainfrom
Xyerophyte:fix/broken-doc-links-eslint-plugin-4219

Conversation

@Xyerophyte
Copy link
Copy Markdown

Summary

  • Fixes broken 'Further Reading' links in sap-flex-enabled and sap-state-preservation-mode rule documentation
  • The sap-flex-enabled link had a truncated topic ID (31 chars instead of 32, missing trailing f) and used a non-standard /sdk/ URL prefix that causes hash fragment loss on redirect
  • The sap-state-preservation-mode links pointed to non-existent topic IDs (b2cc3b59... and c4f3d41f... return 404). Replaced with correct verified IDs for the V2-specific 'Enabling Discovery/Persistence Mode' and 'Enabling the Flexible Column Layout' docs
  • Also removes /sdk/ prefix from sap-table-personalization and sap-enable-export docs for consistency
  • All new topic IDs verified as HTTP 200 against sapui5.hana.ondemand.com

Fixes #4219

Changes

File Fix
docs/rules/sap-flex-enabled.md f1430c0...ff76a -> f1430c0...ff76af (added missing char) + removed /sdk/
src/rules/sap-flex-enabled.ts Removed /sdk/ prefix from rule metadata URL
docs/rules/sap-state-preservation-mode.md Replaced both broken topic IDs with correct ones (69503c2..., 75631b7...)
docs/rules/sap-table-personalization.md Removed /sdk/ prefix
docs/rules/sap-enable-export.md Removed /sdk/ prefix

Test plan

  • All old URLs confirmed as HTTP 404
  • All new URLs confirmed as HTTP 200
  • Click each Further Reading link in the updated docs to verify it loads the correct SAP documentation page

…e docs

Fix broken Further Reading links in sap-flex-enabled and sap-state-preservation-mode rule docs. The sap-flex-enabled link had a truncated topic ID (missing trailing character) and used a non-standard /sdk/ URL prefix. The sap-state-preservation-mode links pointed to non-existent topic IDs. Also removes /sdk/ prefix from sap-table-personalization and sap-enable-export docs for consistency. All topic IDs verified against sapui5.hana.ondemand.com. Fixes SAP#4219

Made-with: Cursor
@Xyerophyte Xyerophyte requested a review from a team as a code owner March 14, 2026 21:53
Copilot AI review requested due to automatic review settings March 14, 2026 21:53
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 14, 2026

⚠️ No Changeset found

Latest commit: f5fb151

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cla-assistant
Copy link
Copy Markdown

cla-assistant bot commented Mar 14, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Xyerophyte
❌ harsh
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates rule documentation to point to valid SAP UI5 documentation pages, resolving broken “Further Reading” links reported in #4219 and aligning link formats across rule docs and metadata.

Changes:

  • Fixes the sap-flex-enabled topic URL (correct topic ID + removes /sdk/ prefix) in both the rule doc and rule metadata.
  • Replaces broken/non-existent topic IDs in sap-state-preservation-mode documentation with verified working topic IDs.
  • Removes the /sdk/ prefix from “Further Reading” links in sap-table-personalization and sap-enable-export docs for consistency.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/eslint-plugin-fiori-tools/src/rules/sap-flex-enabled.ts Updates ESLint rule metadata docs.url to use the non-/sdk/ UI5 topic URL.
packages/eslint-plugin-fiori-tools/docs/rules/sap-flex-enabled.md Fixes “Further Reading” link to the correct, non-truncated UI5 topic ID and removes /sdk/.
packages/eslint-plugin-fiori-tools/docs/rules/sap-state-preservation-mode.md Replaces two 404 topic links with verified working topic IDs.
packages/eslint-plugin-fiori-tools/docs/rules/sap-table-personalization.md Removes /sdk/ prefix from the “Further Reading” UI5 topic link.
packages/eslint-plugin-fiori-tools/docs/rules/sap-enable-export.md Removes /sdk/ prefix from the “Further Reading” UI5 topic link.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@Xyerophyte Xyerophyte requested a review from a team as a code owner April 12, 2026 11:27
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.

BUG - Broken Documentation Links for Rules in @sap-ux/eslint-plugin-fiori-tools Redirect to "Page Not Found"

4 participants