Skip to content

Component Docs Fix#225

Merged
korgon merged 4 commits intomainfrom
component-docs
Mar 5, 2026
Merged

Component Docs Fix#225
korgon merged 4 commits intomainfrom
component-docs

Conversation

@korgon
Copy link
Contributor

@korgon korgon commented Mar 5, 2026

  • updating references for component imports as well as route to correct storybook build

Copilot AI review requested due to automatic review settings March 5, 2026 04:02
@korgon korgon requested a review from dkonieczek March 5, 2026 04:04
Copy link
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 documentation references to align with the current Snap Preact package export structure so the Storybook/docs build and code samples point at the correct module paths.

Changes:

  • Replaced @athoscommerce/snap-preact-components references with the subpath export @athoscommerce/snap-preact/components across component docs/readmes and Snap docs.
  • Updated the docs site iframe URL for “Preact Components” to the new Storybook output location.
  • Refreshed example imports in snap-controller Search README to match the new export path.

Reviewed changes

Copilot reviewed 57 out of 57 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
packages/snap-preact/components/src/documentation/Usage/Usage.md Updates component import example to @athoscommerce/snap-preact/components.
packages/snap-preact/components/src/documentation/Theme/Theme.md Updates ThemeProvider/Button import example to new export path.
packages/snap-preact/components/src/documentation/About/About.md Updates installation instructions for components docs (currently incorrect; see comment).
packages/snap-preact/components/src/components/Trackers/ResultTracker/readme.md Updates ResultTracker import example to new export path.
packages/snap-preact/components/src/components/Templates/RecommendationBundle/readme.md Updates RecommendationBundle import example to new export path.
packages/snap-preact/components/src/components/Templates/Recommendation/readme.md Updates Recommendation import example to new export path.
packages/snap-preact/components/src/components/Organisms/Results/readme.md Updates Results import example to new export path.
packages/snap-preact/components/src/components/Organisms/FilterSummary/readme.md Updates FilterSummary import example to new export path.
packages/snap-preact/components/src/components/Organisms/Facets/readme.md Updates Facets import example to new export path.
packages/snap-preact/components/src/components/Organisms/Facet/readme.md Updates Facet import example to new export path.
packages/snap-preact/components/src/components/Organisms/BranchOverride/readme.md Updates BranchOverride import example to new export path.
packages/snap-preact/components/src/components/Organisms/Autocomplete/readme.md Updates Autocomplete import example to new export path.
packages/snap-preact/components/src/components/Molecules/VariantSelection/readme.md Updates VariantSelection import example to new export path.
packages/snap-preact/components/src/components/Molecules/Swatches/readme.md Updates Swatches import example to new export path.
packages/snap-preact/components/src/components/Molecules/Slideout/readme.md Updates Slideout import example to new export path.
packages/snap-preact/components/src/components/Molecules/Select/readme.md Updates Select import example to new export path.
packages/snap-preact/components/src/components/Molecules/SearchInput/readme.md Updates SearchInput import example to new export path.
packages/snap-preact/components/src/components/Molecules/Result/readme.md Updates Result import example to new export path.
packages/snap-preact/components/src/components/Molecules/Pagination/readme.md Updates Pagination import example to new export path.
packages/snap-preact/components/src/components/Molecules/OverlayBadge/readme.md Updates OverlayBadge import example to new export path.
packages/snap-preact/components/src/components/Molecules/List/readme.md Updates List import example to new export path.
packages/snap-preact/components/src/components/Molecules/Grid/readme.md Updates Grid import example to new export path.
packages/snap-preact/components/src/components/Molecules/Filter/readme.md Updates Filter import example to new export path.
packages/snap-preact/components/src/components/Molecules/FacetSlider/readme.md Updates FacetSlider import example to new export path.
packages/snap-preact/components/src/components/Molecules/FacetPaletteOptions/readme.md Updates FacetPaletteOptions import example to new export path.
packages/snap-preact/components/src/components/Molecules/FacetListOptions/readme.md Updates FacetListOptions import example to new export path.
packages/snap-preact/components/src/components/Molecules/FacetHierarchyOptions/readme.md Updates FacetHierarchyOptions import example to new export path.
packages/snap-preact/components/src/components/Molecules/FacetGridOptions/readme.md Updates FacetGridOptions import example to new export path.
packages/snap-preact/components/src/components/Molecules/ErrorHandler/readme.md Updates ErrorHandler import example to new export path.
packages/snap-preact/components/src/components/Molecules/Checkbox/readme.md Updates Checkbox import example to new export path.
packages/snap-preact/components/src/components/Molecules/Carousel/readme.md Updates Carousel import example to new export path.
packages/snap-preact/components/src/components/Molecules/CalloutBadge/readme.md Updates CalloutBadge import example to new export path.
packages/snap-preact/components/src/components/Atoms/Skeleton/readme.md Updates Skeleton import example to new export path.
packages/snap-preact/components/src/components/Atoms/Price/readme.md Updates Price import example to new export path.
packages/snap-preact/components/src/components/Atoms/Overlay/readme.md Updates Overlay import example to new export path.
packages/snap-preact/components/src/components/Atoms/Loading/readme.md Updates LoadingBar import example to new export path.
packages/snap-preact/components/src/components/Atoms/InlineBanner/readme.md Updates InlineBanner import example to new export path.
packages/snap-preact/components/src/components/Atoms/Image/readme.md Updates Image import example to new export path.
packages/snap-preact/components/src/components/Atoms/Icon/readme.md Updates Icon import example to new export path.
packages/snap-preact/components/src/components/Atoms/FormattedNumber/readme.md Updates FormattedNumber import example to new export path.
packages/snap-preact/components/src/components/Atoms/Dropdown/readme.md Updates Dropdown import example to new export path.
packages/snap-preact/components/src/components/Atoms/Button/readme.md Updates Button import example to new export path.
packages/snap-preact/components/src/components/Atoms/Breadcrumbs/readme.md Updates Breadcrumbs import example to new export path.
packages/snap-preact/components/src/components/Atoms/Banner/readme.md Updates Banner import example to new export path.
packages/snap-preact/components/src/components/Atoms/BadgeText/readme.md Updates BadgeText import example to new export path.
packages/snap-preact/components/src/components/Atoms/BadgeRectangle/readme.md Updates BadgeRectangle import example to new export path.
packages/snap-preact/components/src/components/Atoms/BadgePill/readme.md Updates BadgePill import example to new export path.
packages/snap-preact/components/src/components/Atoms/BadgeImage/readme.md Updates BadgeImage import example to new export path.
packages/snap-controller/src/Search/README.md Updates example imports to use @athoscommerce/snap-preact/components.
docs/documents.js Updates docs iframe URL to Storybook build output under packages/snap-preact/components/docs/.
docs/SNAP_TRACKING.md Updates tracking-related imports/references to new components export path.
docs/SNAP_SEARCH.md Updates components import paths in search documentation/examples (one symbol name issue noted in comment).
docs/SNAP_RECOMMENDATIONS.md Updates recommendation imports/references to new components export path.
docs/SNAP_OVERVIEW.md Updates overview imports/references to new components export path.
docs/SNAP_FINDER.md Updates Finder docs imports to new components export path.
docs/SNAP_AUTOCOMPLETE.md Updates dynamic import path and references to new components export path.
docs/REFERENCE_CONFIGURATION_TARGETERS.md Updates skeleton-related reference text/import to new components export path (wording improvements noted in comment).

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

Copy link
Contributor

@dkonieczek dkonieczek left a comment

Choose a reason for hiding this comment

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

Valid copilot comments

@korgon korgon merged commit 80d936d into main Mar 5, 2026
1 check passed
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.

3 participants