Skip to content

docs: manaul review of doc links#1461

Merged
korgon merged 3 commits into
developfrom
doc-manual-review
Mar 11, 2026
Merged

docs: manaul review of doc links#1461
korgon merged 3 commits into
developfrom
doc-manual-review

Conversation

@dkonieczek

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR performs a manual review of documentation links across the repository. It converts Markdown-style links to HTML anchor tags (with target="_blank" and rel="noopener noreferrer") for external URLs, fixes broken or incorrect links (e.g., the Foreground Filters link in the deploy checklist, the UrlTranslator config link path), and adds new link-rewrite mappings to doc-app.js so that GitHub source URLs are rewritten to internal doc routes.

Changes:

  • Converted Markdown-style links to HTML anchor tags with security attributes (target="_blank" rel="noopener noreferrer") across several component readme files.
  • Fixed previously broken doc links (e.g., foreground-filters link, UrlTranslator README path) and updated external link targets (e.g., @preact/preset-vite now points to npm).
  • Added new GitHub→internal route link-rewrite rules in doc-app.js to cover platforms, templates, and snap-preact-components.

Reviewed changes

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

Show a summary per file
File Description
ResultTracker/readme.md Added a note about the withTracking HoC as an alternative
RecommendationBundle/readme.md Converted Swiper links from Markdown to HTML anchor tags
Recommendation/readme.md Converted Swiper links from Markdown to HTML anchor tags (has broken tag)
FacetSlider/readme.md Converted react-ranger link from Markdown to HTML anchor tag
Carousel/readme.md Converted Swiper links from Markdown to HTML anchor tags
Price/readme.md Updated link to toolbox filters doc (with incorrect package name in link text)
FormattedNumber/readme.md Updated link to toolbox filters doc (with incorrect package name in link text)
docs/REFERENCE_CONFIGURATION.md Removed README.md from the UrlTranslator config link path
docs/BUILD_DEPLOY_CHECKLIST.md Fixed foreground-filters link (was incorrectly pointing to background-filters)
docs/BUILD_DEPLOY.md Replaced GitHub link for @preact/preset-vite with npm link
doc-app.js Added new GitHub→internal route rewrite rules for platforms, templates, and components

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

Comment thread packages/snap-preact-components/src/components/Molecules/Carousel/readme.md Outdated
Comment thread packages/snap-preact-components/src/components/Organisms/Recommendation/readme.md Outdated
Comment thread packages/snap-preact-components/src/components/Atoms/Price/readme.md Outdated
Comment thread packages/snap-preact-components/src/components/Atoms/FormattedNumber/readme.md Outdated
Comment thread packages/snap-preact-components/src/components/Molecules/FacetSlider/readme.md Outdated
@dkonieczek dkonieczek linked an issue Mar 10, 2026 that may be closed by this pull request
dkonieczek and others added 2 commits March 10, 2026 15:11
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@korgon korgon merged commit f0ffd27 into develop Mar 11, 2026
1 check passed
@korgon korgon deleted the doc-manual-review branch March 11, 2026 02:03
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.

Validate Docs Links

3 participants