Skip to content

Fix broken internal links from link checker report#2224

Open
Copilot wants to merge 8 commits intomainfrom
copilot/fix-link-checker-errors
Open

Fix broken internal links from link checker report#2224
Copilot wants to merge 8 commits intomainfrom
copilot/fix-link-checker-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 7, 2026

18 broken links detected by the automated link checker, primarily due to incorrect /docs/ prefixes on internal links and stale paths pointing to moved/non-existent pages.

Link fixes

  • Removed erroneous /docs/ prefix from internal links across files — the site root is /, not /docs/

    • extendability.md (in guides/) — /docs/guides/plugins/apps/app-scripts/ → relative path ../../../plugins/apps/app-scripts/
    • 2020-08-12-implement-app-system-inside-platform.md/docs/guides/plugins/apps/storefront//guides/plugins/apps/storefront/
    • How-to-define-your-custom-Elasticsearch-definition.md/docs/resources/references/adr/... → relative path ../../../resources/references/adr/...
  • Fixed stale paths pointing to moved or non-existent pages:

    • quality-guidelines.md: /development/tooling/cli → relative path ../../../products/cli/ (CLI docs live under products/)
    • 2024-10-02-vue-2-options-api-to-vue-3-composition-api-conversion-codemod.md: /docs/guides/plugins/plugins/administration/system-updates/vue-native.html/guides/upgrades-migrations/administration/vue-native (page was moved)
  • Excluded externally managed files: Links in resources/guidelines/code/core/* are handled externally and left unchanged.

Link checker workflow

Added --exclude "/resources/admin-extension-sdk" to the lychee args in validate-external-links.yml. These paths are injected post-build from an external source and validated separately.

Agent-Logs-Url: https://github.com/shopware/docs/sessions/38ddef6d-fa21-4767-8b8d-baf084dbea89

Co-authored-by: Isengo1989 <8600299+Isengo1989@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix errors in link checker report Fix broken internal links from link checker report Apr 7, 2026
@Isengo1989 Micha Hobert (Isengo1989) marked this pull request as ready for review April 9, 2026 08:53
Copilot AI review requested due to automatic review settings April 9, 2026 08:53
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

Fixes internal documentation links flagged by the automated link checker, primarily by removing erroneous /docs/ prefixes and updating stale paths to their current locations. Also adjusts the link-checker workflow to ignore Admin Extension SDK routes that are injected post-build.

Changes:

  • Updated multiple Markdown files to use correct root-relative internal paths (removing /docs/ and dropping stale .html/moved-page URLs).
  • Pointed monetization quality guidelines at the current Shopware CLI docs location under /products/.
  • Updated the lychee workflow to exclude Admin Extension SDK paths from link checking.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
resources/references/adr/2024-10-02-vue-2-options-api-to-vue-3-composition-api-conversion-codemod.md Updates the referenced Vue migration doc link to the new location.
resources/references/adr/2020-08-12-implement-app-system-inside-platform.md Removes incorrect /docs/ prefix from the Storefront Customizations guide link.
resources/guidelines/code/core/feature-flags.md Fixes Backward Compatibility guide link path (removes /docs/ + stale .html).
resources/guidelines/code/core/extendability.md Fixes App scripts guide link path (removes /docs/).
resources/guidelines/code/core/database-migations.md Fixes Backward Compatibility guide link path (removes /docs/ + stale .html).
products/extensions/advanced-search/How-to-define-your-custom-Elasticsearch-definition.md Fixes ADR link path (removes /docs/).
guides/development/monetization/quality-guidelines.md Updates Shopware CLI link to /products/cli/.
guides/development/extensions/architecture/extendability.md Fixes App scripts guide link path (removes /docs/).
.github/workflows/validate-external-links.yml Adds lychee exclusion for /resources/admin-extension-sdk links.

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Isengo1989
Copy link
Copy Markdown
Contributor

Copilot ignore the links in resources/guidelines/code/core/* they are handled externally.

Co-authored-by: Bojan Rajh <117360292+bojanrajh@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 9, 2026

Copilot ignore the links in resources/guidelines/code/core/* they are handled externally.

The changes to resources/guidelines/code/core/* files were already reverted in a previous commit (dd2ae73). Those files are now back to their original state, matching the externally managed content.

@Isengo1989
Copy link
Copy Markdown
Contributor

Micha Hobert (Isengo1989) commented Apr 9, 2026

Bojan Rajh (@bojanrajh) removed the ones that didn't make sense. Will follow up on -> ADRs and admin-extension sdk links.

WDYT about just adding full URLs like https://developer.shopware.com/resources/admin-extension-sdk instead of paths ? I mean what's the point if we can not check for them, at least this way we know they are broken at any given point. Currently we have 9 rel -paths on adminsdk

@bojanrajh
Copy link
Copy Markdown
Contributor

Micha Hobert (@Isengo1989) I would prefer relative links, I'm not sure if vitepress is able to handle same-domain links the same way. Deadlinks from admin SDK will be (and are already) checked in the healthcheck workflow. Looking forward to actually forcing the check.

@Isengo1989
Copy link
Copy Markdown
Contributor

Micha Hobert (Micha Hobert (@Isengo1989)) I would prefer relative links, I'm not sure if vitepress is able to handle same-domain links the same way. Deadlinks from admin SDK will be (and are already) checked in the healthcheck workflow. Looking forward to actually forcing the check.

Ok, fine by me, sadly, there is no way to avoid these false errors AFAIK. Please approve the other changes then.

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

Labels

bugfix Bugfixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link Checker Report

4 participants