fix(eslint-plugin-fiori-tools): fix broken documentation links in rule docs#4417
fix(eslint-plugin-fiori-tools): fix broken documentation links in rule docs#4417Xyerophyte wants to merge 2 commits intoSAP:mainfrom
Conversation
…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
|
|
|
There was a problem hiding this comment.
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-enabledtopic 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-modedocumentation with verified working topic IDs. - Removes the
/sdk/prefix from “Further Reading” links insap-table-personalizationandsap-enable-exportdocs 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.
Summary
sap-flex-enabledandsap-state-preservation-moderule documentationsap-flex-enabledlink had a truncated topic ID (31 chars instead of 32, missing trailingf) and used a non-standard/sdk/URL prefix that causes hash fragment loss on redirectsap-state-preservation-modelinks pointed to non-existent topic IDs (b2cc3b59...andc4f3d41f...return 404). Replaced with correct verified IDs for the V2-specific 'Enabling Discovery/Persistence Mode' and 'Enabling the Flexible Column Layout' docs/sdk/prefix fromsap-table-personalizationandsap-enable-exportdocs for consistencyFixes #4219
Changes
docs/rules/sap-flex-enabled.mdf1430c0...ff76a->f1430c0...ff76af(added missing char) + removed/sdk/src/rules/sap-flex-enabled.ts/sdk/prefix from rule metadata URLdocs/rules/sap-state-preservation-mode.md69503c2...,75631b7...)docs/rules/sap-table-personalization.md/sdk/prefixdocs/rules/sap-enable-export.md/sdk/prefixTest plan