Skip to content

Commit 70a8bea

Browse files
authored
docs: replace docs/(qwik)/components/ with docs/(qwik)/core/ (#7966)
1 parent 67e9bd7 commit 70a8bea

File tree

29 files changed

+62
-62
lines changed

29 files changed

+62
-62
lines changed

packages/docs/public/_redirects

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@
6969
/docs/components/inline-components/ /docs/core/overview/ 308
7070
/docs/think-qwik/ /docs/concepts/think-qwik/ 308
7171
/docs/env-variables/ /docs/guides/env-variables/ 308
72-
/docs/components/ /docs/core/ 308
72+
/docs/components/* /docs/core/:splat 308

packages/docs/src/components/on-this-page/on-this-page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ const makeEditPageUrl = (url: string): string => {
100100
if (index !== -1 && index + 1 >= segments.length) {
101101
// These are directory paths without subpaths, map to their overview pages
102102
if (componentIndex !== -1) {
103-
return 'docs/(qwik)/components/overview';
103+
return 'docs/(qwik)/core/overview';
104104
} else if (conceptIndex !== -1) {
105105
return 'docs/(qwik)/concepts/think-qwik';
106106
}

packages/docs/src/routes/docs/(qwik)/concepts/reactivity/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Qwik uses proxies for a few reasons:
4646

4747
Because of the above constraints, Qwik uses proxies to keep track of the reactivity graph.
4848

49-
- Use [`useStore()`](/docs/(qwik)/components/state/index.mdx#usestore) to create a store proxy.
49+
- Use [`useStore()`](/docs/(qwik)/core/state/index.mdx#usestore) to create a store proxy.
5050
- The proxy notices the reads and creates subscriptions that are serializable.
5151
- The proxy notices the writes and uses the subscription information to invalidate the relevant components.
5252

packages/docs/src/routes/docs/(qwik)/core/events/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export default component$(() => {
5757
```
5858
</CodeSandbox>
5959

60-
You can also use `bind:propertyName` to conveniently have a [two-way binding](/docs/(qwik)/components/rendering/index.mdx#bind-attribute) between a signal and an input element.
60+
You can also use `bind:propertyName` to conveniently have a [two-way binding](/docs/(qwik)/core/rendering/index.mdx#bind-attribute) between a signal and an input element.
6161

6262
Notice that `onClick$` ends with [`$`](/docs/(qwik)/advanced/dollar/index.mdx). This is a hint to both the [Optimizer](/docs/(qwik)/advanced/optimizer/index.mdx) and the developer that a special transformation occurs at this location. The presence of the `$` suffix implies a lazy-loaded boundary here. The code associated with the `click` handler is not loaded into the JavaScript Virtual Machine (VM) until the user activates the click event. However, to avoid delays during the first interaction, it is eagerly loaded into the browser cache.
6363

packages/docs/src/routes/docs/(qwik)/core/state/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export default component$(() => {
123123

124124
> **NOTE** For reactivity to work as expected, make sure to keep a reference to the reactive object and not only to its properties. e.g. doing `let { count } = useStore({ count: 0 })` and then mutating `count` won't trigger updates of components that depend on the property.
125125
126-
Because [`useStore()`](/docs/(qwik)/components/state/index.mdx#usestore) tracks deep reactivity, that means that Arrays and Objects inside the store will also be reactive.
126+
Because [`useStore()`](/docs/(qwik)/core/state/index.mdx#usestore) tracks deep reactivity, that means that Arrays and Objects inside the store will also be reactive.
127127

128128
<CodeSandbox src="/src/routes/demo/state/counter-store-deep/index.tsx" style={{ height: '10em' }}>
129129
```tsx
@@ -225,10 +225,10 @@ In Qwik, there are two ways to create computed values, each with a different use
225225

226226
1. `useComputed$()`: `useComputed$()` is the preferred way of creating computed values. Use it when the computed value can be derived synchronously purely from the source state (current application state). For example, creating a lowercase version of a string or combining first and last names into a full name.
227227

228-
2. [`useResource$()`](/docs/(qwik)/components/state/index.mdx#useresource): `useResource$()` is used when the computed value is asynchronous or the state comes from outside of the application. For example, fetching the current weather (external state) based on a current location (application internal state).
228+
2. [`useResource$()`](/docs/(qwik)/core/state/index.mdx#useresource): `useResource$()` is used when the computed value is asynchronous or the state comes from outside of the application. For example, fetching the current weather (external state) based on a current location (application internal state).
229229

230230

231-
In addition to the two ways of creating computed values described above, there is also a lower-level ([`useTask$()`](/docs/(qwik)/components/tasks/index.mdx#usetask)). This way does not produce a new signal, but rather modifies the existing state or produces a side effect.
231+
In addition to the two ways of creating computed values described above, there is also a lower-level ([`useTask$()`](/docs/(qwik)/core/tasks/index.mdx#usetask)). This way does not produce a new signal, but rather modifies the existing state or produces a side effect.
232232

233233
### `useComputed$()`
234234

@@ -390,7 +390,7 @@ The state `resource.loading` can be one of the following:
390390
- `false` - the data is not yet available.
391391
- `true` - the data is available. (Either resolved or rejected.)
392392

393-
The callback passed to [`useResource$()`](/docs/(qwik)/components/state/index.mdx#useresource) runs right after the [`useTask$()`](/docs/(qwik)/components/tasks/index.mdx#usetask) callbacks complete. Please refer to the [Lifecycle](../tasks/index.mdx#lifecycle) section for more details.
393+
The callback passed to [`useResource$()`](/docs/(qwik)/core/state/index.mdx#useresource) runs right after the [`useTask$()`](/docs/(qwik)/core/tasks/index.mdx#usetask) callbacks complete. Please refer to the [Lifecycle](../tasks/index.mdx#lifecycle) section for more details.
394394

395395
#### `<Resource />`
396396

packages/docs/src/routes/docs/(qwik)/core/styles/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ The problem with this approach is that we will load styles twice.
479479
1. The styles are inserted into the HTML as part of the SSR.
480480
2. Then when the component is invalidated and needs to be re-rendered, the styles are loaded again because they are inlined.
481481

482-
What is needed is to load the styles independently from the component. This is what [`useStyles$()`](/docs/(qwik)/components/styles/index.mdx#usestyles) is for. There are two scenarios:
482+
What is needed is to load the styles independently from the component. This is what [`useStyles$()`](/docs/(qwik)/core/styles/index.mdx#usestyles) is for. There are two scenarios:
483483

484484
1. The component is rendered on the server and the styles are inserted into `<head>` as part of the SSR.
485485
- Adding a new instance of a component to the application does not require that we load the styles as they are already included as part of SSR.

packages/docs/src/routes/docs/(qwik)/core/tasks/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ When the user interacts with the application, it resumes on the client-side, con
9393

9494
`useTask$()` registers a hook to be executed upon component creation, it will run at least once either in the server or in the browser, depending on where the component is initially rendered.
9595

96-
Additionally, this task can be reactive and will re-execute when **tracked** [state](/docs/(qwik)/components/state/index.mdx) changes.
96+
Additionally, this task can be reactive and will re-execute when **tracked** [state](/docs/(qwik)/core/state/index.mdx) changes.
9797

9898
**Notice that any subsequent re-execution of the task will always happen in the browser**, because reactivity is a browser-only thing.
9999

@@ -323,7 +323,7 @@ export default component$(() => {
323323

324324
## `useVisibleTask$()`
325325

326-
Sometimes a task needs to run only on the browser and after rendering, in that case, you should use `useVisibleTask$()`. The `useVisibleTask$()` is similar to `useTask$()` but it only runs on the browser and after initial rendering. `useVisibleTask$()` registers a hook to be executed when the component becomes visible in the viewport, it will run at least once in the browser, and it can be reactive and re-execute when some **tracked** [state](/docs/(qwik)/components/state/index.mdx) changes.
326+
Sometimes a task needs to run only on the browser and after rendering, in that case, you should use `useVisibleTask$()`. The `useVisibleTask$()` is similar to `useTask$()` but it only runs on the browser and after initial rendering. `useVisibleTask$()` registers a hook to be executed when the component becomes visible in the viewport, it will run at least once in the browser, and it can be reactive and re-execute when some **tracked** [state](/docs/(qwik)/core/state/index.mdx) changes.
327327

328328
`useVisibleTask$()` has these properties:
329329

packages/docs/src/routes/docs/(qwik)/faq/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ We also have an interactive [tutorial](../../tutorial/welcome/overview/) to get
7272

7373
## What are all those `$` signs?
7474

75-
You might have noticed there are more [`$`](../advanced/dollar/index.mdx) signs than usual in Qwik apps, such as: [`component$()`](/docs/(qwik)/components/overview/index.mdx#component), [`useTask$()`](/docs/(qwik)/components/tasks/index.mdx#usetask), and `<div onClick$={() => console.log('click')} />`. It serves as a marker for a lazy-load boundary. Qwik breaks your application into small chunks; these pieces are smaller than the component itself. For event handlers, hooks, etc. The `$` signals to both the [optimizer](../advanced/optimizer/index.mdx) and the developer when it's happening.
75+
You might have noticed there are more [`$`](../advanced/dollar/index.mdx) signs than usual in Qwik apps, such as: [`component$()`](/docs/(qwik)/core/overview/index.mdx#component), [`useTask$()`](/docs/(qwik)/core/tasks/index.mdx#usetask), and `<div onClick$={() => console.log('click')} />`. It serves as a marker for a lazy-load boundary. Qwik breaks your application into small chunks; these pieces are smaller than the component itself. For event handlers, hooks, etc. The `$` signals to both the [optimizer](../advanced/optimizer/index.mdx) and the developer when it's happening.
7676

7777
**Example:**
7878

packages/docs/src/routes/docs/(qwik)/getting-started/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ export default component$(() => {
142142
>
143143
> - Your `joke` route default component is surrounded by an existing layout. See [Layout](/docs/layout/) for more details on what layouts are and how to work with them.
144144
> - index.tsx, layout.tsx in routes folder, root.tsx and all entry files need **export default**. For other components you can use export const and export function
145-
> - For more details about how to author components, see the [Component API](/docs/(qwik)/components/overview/index.mdx) section.
145+
> - For more details about how to author components, see the [Component API](/docs/(qwik)/core/overview/index.mdx) section.
146146
147147
### 2. Loading Data
148148

@@ -623,9 +623,9 @@ For more on just how much you can achieve with Qwik, check out the dedicated doc
623623

624624
- [Project structure](/docs/(qwikcity)/project-structure/index.mdx)
625625
- [Directory-based routing](/docs/(qwikcity)/routing/index.mdx#directory-based-routing)
626-
- [Component](/docs/(qwik)/components/overview/index.mdx)
626+
- [Component](/docs/(qwik)/core/overview/index.mdx)
627627
- [Route loaders](/docs/(qwikcity)/route-loader/index.mdx)
628628
- [Form actions](/docs/(qwikcity)/action/index.mdx) && [zod validation](/docs/(qwikcity)/action/index.mdx#validation-and-type-safety)
629-
- [State management](/docs/(qwik)/components/state/index.mdx)
630-
- [Tasks](/docs/(qwik)/components/tasks/index.mdx#use-usetask-when-you-need-to)
629+
- [State management](/docs/(qwik)/core/state/index.mdx)
630+
- [Tasks](/docs/(qwik)/core/tasks/index.mdx#use-usetask-when-you-need-to)
631631
- [Preloading](/docs/(qwikcity)/advanced/speculative-module-fetching/index.mdx)

packages/docs/src/routes/docs/(qwikcity)/advanced/menu/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Use `menu.md` to declare the menu structure.
6363

6464
## Components
6565

66-
- [Basics](/docs/(qwik)/components/basics/index.mdx)
66+
- [Basics](/docs/(qwik)/core/basics/index.mdx)
6767
```
6868

6969
## Retrieving Menu Structure
@@ -90,7 +90,7 @@ The example above will return:
9090
items: [
9191
{
9292
text: "Basics",
93-
href: "/docs/(qwik)/components/basics"
93+
href: "/docs/(qwik)/core/basics"
9494
}
9595
],
9696
},

0 commit comments

Comments
 (0)