Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses broken documentation links (per issue 2206) by updating several internal references across the docs, including replacing outdated paths and switching some references to stable external URLs.
Changes:
- Update README references to repository config/workflow files to use GitHub URLs.
- Fix and modernize several documentation cross-links (e.g., DAL/Search Criteria references, Composable Frontends URL).
- Adjust product documentation links (e.g., Digital Sales Rooms devenv setup path, Rule Builder guide link).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Switches several config/workflow file links to GitHub URLs and adjusts related documentation text. |
| products/digital-sales-rooms/index.md | Updates the devenv installation link to the legacy setup location. |
| guides/plugins/plugins/framework/data-handling/reading-data.md | Repoints DAL filter/aggregation references to Search Criteria documentation. |
| guides/plugins/apps/app-scripts/data-loading.md | Updates API/Search Criteria links to the newer integrations API docs location. |
| guides/plugins/apps/app-scripts/custom-endpoints.md | Repoints integrations API link to the newer docs location. |
| guides/development/integrations-api/search-criteria.md | Replaces DAL reference links with links to the “Reading data” guide sections. |
| concepts/extensions/apps-concept.md | Fixes Rule Builder link target. |
| concepts/commerce/content/shopping-experiences-cms.md | Replaces broken Composable Frontends relative link with the external site URL. |
| concepts/commerce/catalog/products.md | Replaces broken Composable Frontends relative link with the external site URL. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Grammar and language check | ||
|
|
||
| All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in [`.reviewdog.yml`](./.github/workflows/reviewdog.yml). It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in [Language and Grammar](./resources/guidelines/documentation-guidelines/03-language-and-grammar.md) section. | ||
| All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in [`.reviewdog.yml`](https://github.com/shopware/docs/blob/main/.github/workflows/reviewdog.yml). It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in [Language and Grammar](./resources/guidelines/documentation-guidelines/03-language-and-grammar.md) section. |
There was a problem hiding this comment.
The link label says .reviewdog.yml, but the target points to .github/workflows/reviewdog.yml, and there is no .reviewdog.yml file in the repo. This is misleading and looks like a broken reference for readers—either update the label to match the actual file name/location or link to the real Reviewdog config if it exists elsewhere.
| ### Markdown check | ||
|
|
||
| The markdown files are checked with [markdown-lint](https://github.com/avto-dev/markdown-lint) to identify issues such as formatting errors, style inconsistencies, etc. By doing so, it facilitates the creation of well-structured and consistent Markdown documents.. The configuration for markdown-lint can be found in [`markdown-style-check.yml`](./.github/workflows/markdown-style-check.yml). | ||
| The markdown files are checked with [markdown-lint](https://github.com/avto-dev/markdown-lint) to identify issues such as formatting errors, style inconsistencies, etc. By doing so, it facilitates the creation of well-structured and consistent Markdown documents.. The configuration for markdown-lint can be found in [`markdown-style-check.yml`](https://github.com/shopware/docs/blob/main/.github/workflows/markdown-style-check.yml). |
There was a problem hiding this comment.
There is a double period in “Markdown documents..”. Please remove the extra '.' to avoid a typo in the rendered README.
| ### Media file format check | ||
|
|
||
| The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines. | ||
| The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](https://github.com/shopware/docs/blob/main/.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines. |
There was a problem hiding this comment.
This refers to a /docs/assets folder, but this repository uses the top-level assets/ directory (and there is no docs/ directory). Consider updating the path in the text to match the actual location to avoid confusing contributors.
Suggested change
| The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](https://github.com/shopware/docs/blob/main/.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines. | |
| The `assets/` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](https://github.com/shopware/docs/blob/main/.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines. |
| Refer to the [App Base Guide](../app-base-guide#permissions) for more information on how permissions work for apps. | ||
|
|
||
| The `repository` service exposes the same data as the CRUD-operations of the [Admin API](../../../integrations-api/#backend-facing-integrations---admin-api), whereas the `store` service gives access to the same data as the [Store API](../../../integrations-api/#customer-facing-interactions---store-api). | ||
| The `repository` service exposes the same data as the CRUD-operations of the [Admin API](../../../../guides/development/integrations-api/#backend-facing-integrations---admin-api), whereas the `store` service gives access to the same data as the [Store API](../../../../guides/development/integrations-api/#customer-facing-interactions---store-api). |
There was a problem hiding this comment.
The updated links use anchors #backend-facing-integrations---admin-api and #customer-facing-interactions---store-api, but guides/development/integrations-api/index.md does not contain headings that generate these anchors (it has ## Admin API / ## Store API). This makes the new links broken; update the anchors (e.g., #admin-api / #store-api) or link directly to the correct section/page.
Suggested change
| The `repository` service exposes the same data as the CRUD-operations of the [Admin API](../../../../guides/development/integrations-api/#backend-facing-integrations---admin-api), whereas the `store` service gives access to the same data as the [Store API](../../../../guides/development/integrations-api/#customer-facing-interactions---store-api). | |
| The `repository` service exposes the same data as the CRUD-operations of the [Admin API](../../../../guides/development/integrations-api/#admin-api), whereas the `store` service gives access to the same data as the [Store API](../../../../guides/development/integrations-api/#store-api). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.