Skip to content

Commit

Permalink
fix: deadlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
bojanrajh committed Dec 7, 2023
1 parent b8311f7 commit b0a2a8f
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In order to display information of a product there is a `Product` object needed,
- Images
- ...

To achieve that, you can utilize methods available within `composables` package (or directly via API client package named `@shopware-pwa/api-client`). In this example we will use [useProductSearch](../../../packages/composables/useProductSearch.md).
To achieve that, you can utilize methods available within `composables` package (or directly via API client package named `@shopware-pwa/api-client`). In this example we will use [useProductSearch](../../packages/composables/useProductSearch.md).

:::info Associations
Keep in mind that not every field, or inner object of the `Product` entity is available automatically.
Expand Down Expand Up @@ -66,7 +66,7 @@ const productNumber = computed(() => product.value?.productNumber);
Each product can have additional resource loaded asynchronously like Cross-Sells, or Customer Reviews.
Thanks to [useProductAssociations](../../../packages/composables/useProductAssociations.md) composable, you can load it providing the product you are on:
Thanks to [useProductAssociations](../../packages/composables/useProductAssociations.md) composable, you can load it providing the product you are on:
```js
const { loadAssociations, isLoading, productAssociations } =
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/getting-started/page-elements/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In this chapter you will learn how to
### Quick reference

- [useBreadcrumbs](/packages/composables/useBreadcrumbs) is a composable used for a breadcrumbs management with sharable state
- [getCategoryBreadcrumbs](/packages/helpers/getCategoryBreadcrumbs) is a helper used for converting `Category` to the `Breadcrumb` object
- [getCategoryBreadcrumbs](../../packages/helpers/getCategoryBreadcrumbs) is a helper used for converting `Category` to the `Breadcrumb` object

## Building breadcrumbs for a static page

Expand All @@ -49,7 +49,7 @@ Each CMS page contains the `Category` with `breadcrumb` array, which contains a
breadcrumb: ["Home", "Main navigation ", "Summer Party"]
```

we can convert current `string` array to the `Breadcrumb` object using [getCategoryBreadcrumbs](/packages/helpers/getCategoryBreadcrumbs) helper, and then pass it to [useBreadcrumbs](/packages/composables/useBreadcrumbs) composable.
we can convert current `string` array to the `Breadcrumb` object using [getCategoryBreadcrumbs](../../packages/helpers/getCategoryBreadcrumbs) helper, and then pass it to [useBreadcrumbs](../../packages/composables/useBreadcrumbs) composable.

```ts
import { getCategoryBreadcrumbs } from "@shopware-pwa/helpers-next";
Expand All @@ -74,7 +74,7 @@ onBeforeRouteLeave(() => {

## Displaying Breadcrumbs

Breadcrumbs are stored in sharable variable `breadcrumbs` in [useBreadcrumbs](/packages/composables/useBreadcrumbs) composable.
Breadcrumbs are stored in sharable variable `breadcrumbs` in [useBreadcrumbs](../../packages/composables/useBreadcrumbs) composable.

```vue
<script setup lang="ts">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Just copy the code snippet and paste it into your project. Sometimes it's useful

Implementing Footer navigation can be described in few steps:

1. Use [useNavigation](../../../packages/composables/useNavigation) composable to `loadNavigationElements` to display a navigation configured in admin panel.
1. Use [useNavigation](../../../../packages/composables/useNavigation) composable to `loadNavigationElements` to display a navigation configured in admin panel.
2. Iterate over `navigationElements` array of categories and display them.
3. Add some static links next-to dynamic ones if needed.
4. Resolve URLs and implement dedicated pages for it.
Expand Down Expand Up @@ -75,14 +75,14 @@ loadNavigationElements({
</style>
```

[getCategoryUrl](../../../packages/helpers/getCategoryUrl) method imported from `helpers-next` package can extract a SEO Url or technical URL for given category.
[getCategoryUrl](../../../../packages/helpers/getCategoryUrl) method imported from `helpers-next` package can extract a SEO Url or technical URL for given category.

:::warning
`getCategoryUrl` returns absolute path for corresponding category, which means you will get for example `/some-category/some-subcategory` and not the entire URL including domain.

By design, the URL can point also to the Product or Landing Page.
In order to resolve an entity assigned to each category path, utilize a [composable](../../../packages/composables.html#navigation-routing) dedicated for expected entity:
In order to resolve an entity assigned to each category path, utilize a [composable](../../../../packages/composables.html#navigation-routing) dedicated for expected entity:

1. `search` from `useNavigationSearch` to find entity type.
2. use [dedicated composable](../../../packages/composables.html#navigation-routing) to process page resolving.
2. use [dedicated composable](../../../../packages/composables.html#navigation-routing) to process page resolving.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Just copy the code snippet and paste it into your project. Sometimes it's useful to create a new component and use it in a higher level component like a page or a layout.
:::

See also the [complete guide](../../../getting-started/e-commerce/product-detail-page) about the product detail page from the BUILDING section.
See also the [complete guide](../../../../getting-started/e-commerce/product-detail-page) about the product detail page from the BUILDING section.

## Simple Product Detail Page

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/getting-started/page-elements/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ While a file is uploaded, it's been automatically resized for the current config

## Helpers

There are few functions that could be used to extract some crucial information about the media in short way. Browse [Helpers > Media](../packages/helpers.html#Media) category to see them all.
There are few functions that could be used to extract some crucial information about the media in short way. Browse [Helpers > Media](../../packages/helpers.html#Media) category to see them all.

Example how to work with Product's main image:

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/getting-started/templates/astro-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ npm i && npm run dev

## Configure

The blank template is pre-configured to connect to a public Shopware backend, so you can follow our [building guides](/getting-started/) right away.
The blank template is pre-configured to connect to a public Shopware backend, so you can follow our [building guides](../../getting-started/) right away.

In order to connect it to your own store backend, you need to edit the `env.development`:

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/getting-started/templates/blank-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ npm i && npm run dev

## Configure

The blank template is pre-configured to connect to a public Shopware backend, so you can follow our [building guides](/getting-started/) right away.
The blank template is pre-configured to connect to a public Shopware backend, so you can follow our [building guides](../) right away.

In order to connect it to your own store backend, you need to edit the `nuxt.config.ts` file and add a configuration details:

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/packages/api-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Documentation related to the [API Client package](https://github.com/shopware/fr

:::info
A new version of the API Client is currently in development ([see NPM](https://www.npmjs.com/package/@shopware/api-client)).
Features are TypeScript autocompletion and generated types based on the envoirment.
Features are TypeScript autocompletion and generated types based on the environment.
:::

## Additional docs about the API Client
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/resources/integrations/strapi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Now we can add our component to the layout.
## Fetching and displaying pages

:::warning
This example is written for the vue-demo-store template and assuming that you [implemented multi CMS middleware](/resources/integrations/multi-cms.md)
This example is written for the vue-demo-store template and assuming that you [implemented multi CMS middleware](../multi-cms.md)
:::

Create new collection type `Page` on the Stripe admin site with fields:
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/why-shopware-frontends.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This tech-stack is the definition of superior developer experience, quick learni
### Flexible

No theming system means no inheritance magic, drastically reduced compatibility issues, update efforts, and restrictions
to what your site can look like. Build your site in a lego-block-manner by using [prepared templates](./resources/examples/index.md) or just get creative using all perks of [utility-driven CSS](./framework/styling.md).
to what your site can look like. Build your site in a lego-block-manner by using [prepared templates](./examples/) or just get creative using all perks of [utility-driven CSS](./framework/styling.md).

## Limitations

Expand Down

0 comments on commit b0a2a8f

Please sign in to comment.