Skip to content

Commit 17268f7

Browse files
authored
docs: move /docs/components docs/core 📦 (#7958)
1 parent 82cc728 commit 17268f7

File tree

28 files changed

+64
-66
lines changed

28 files changed

+64
-66
lines changed

e2e/docs-e2e/tests/Docs/docs-components-pages-load.spec.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
import { test, expect } from '@playwright/test';
22

33
test('Components Overview page loads', async ({ page }) => {
4-
await page.goto('/docs/components/overview/');
4+
await page.goto('/docs/core/overview/');
55
await expect(page).toHaveTitle('Overview | Components 📚 Qwik Documentation');
66
});
77

88
test('Components State page loads', async ({ page }) => {
9-
await page.goto('/docs/components/state/');
9+
await page.goto('/docs/core/state/');
1010
await expect(page).toHaveTitle('State | Components 📚 Qwik Documentation');
1111
});
1212

1313
test('Components Tasks and Lifecycle page loads', async ({ page }) => {
14-
await page.goto('/docs/components/tasks/');
14+
await page.goto('/docs/core/tasks/');
1515
await expect(page).toHaveTitle('Tasks and Lifecycle | Components 📚 Qwik Documentation');
1616
});
1717

1818
test('Components Context page loads', async ({ page }) => {
19-
await page.goto('/docs/components/context/');
19+
await page.goto('/docs/core/context/');
2020
await expect(page).toHaveTitle('Context | Components 📚 Qwik Documentation');
2121
});
2222

2323
test('Components Slots page loads', async ({ page }) => {
24-
await page.goto('/docs/components/slots/');
24+
await page.goto('/docs/core/slots/');
2525
await expect(page).toHaveTitle('Slots | Components 📚 Qwik Documentation');
2626
});
2727

2828
test('Components Rendering page loads', async ({ page }) => {
29-
await page.goto('/docs/components/rendering/');
29+
await page.goto('/docs/core/rendering/');
3030
await expect(page).toHaveTitle('Rendering | Components 📚 Qwik Documentation');
3131
});
3232

3333
test('Components Styles page loads', async ({ page }) => {
34-
await page.goto('/docs/components/styles/');
34+
await page.goto('/docs/core/styles/');
3535
await expect(page).toHaveTitle('Styles | Components 📚 Qwik Documentation');
3636
});
3737

packages/docs/public/_redirects

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,16 @@
5757
/docs/cheat/qwik-react/ /docs/integrations/react/ 308
5858
/docs/cheat/best-practices/ /docs/guides/best-practices/ 308
5959
/docs/cheat/serialization/ /docs/guides/serialization/ 308
60-
/docs/components/lifecycle/ /docs/components/tasks/ 308
61-
/docs/components/projection/ /docs/components/slots/ 308
62-
/docs/components/resource/ /docs/components/state/ 308
60+
/docs/components/lifecycle/ /docs/core/tasks/ 308
61+
/docs/components/projection/ /docs/core/slots/ 308
62+
/docs/components/resource/ /docs/core/state/ 308
6363
/docs/cookbook/re-exporting-loaders/ /docs/re-exporting-loaders/ 308
6464

6565
/qwikcity/* /docs/:splat 308
6666
/integrations/* /docs/integrations/:splat 308
6767
/deployments/* /docs/deployments/:splat 308
6868
/docs/advanced/i18n/ /docs/integrations/i18n/ 308
69-
/docs/components/inline-components/ /docs/components/overview/ 308
69+
/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

packages/docs/public/_routes.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
"/docs/cheat/qwik-react/",
1313
"/docs/cheat/best-practices/",
1414
"/docs/cheat/serialization/",
15-
"/docs/components/lifecycle/",
16-
"/docs/components/projection/",
17-
"/docs/components/resource/",
15+
"/docs/core/lifecycle/",
16+
"/docs/core/projection/",
17+
"/docs/core/resource/",
1818
"/qwikcity/*",
1919
"/integrations/*",
2020
"/deployments/*",

packages/docs/public/builder/qwik-0.100.0.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/docs/src/routes/(blog)/blog/(articles)/qwik-2-coming-soon/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The output HTML looks like this:
8585

8686
Right away, you might notice that Qwik needs to create “virtual nodes” in the form of comments. So why does Qwik need this information?
8787

88-
- `<!--qv q:s q:sref=5 q:key=-->`: In this example, a parent [Layout](https://qwik.dev/docs/layout/) component (not shown) is used for routing. The parent component creates the `<main/>` element and [projects the route content](https://qwik.dev/docs/components/slots/#slots) (Counter) into the layout component. So, the framework needs to know where the component projected output should be inserted. Qwik needs a virtual node for that.
88+
- `<!--qv q:s q:sref=5 q:key=-->`: In this example, a parent [Layout](https://qwik.dev/docs/layout/) component (not shown) is used for routing. The parent component creates the `<main/>` element and [projects the route content](https://qwik.dev/docs/core/slots/#slots) (Counter) into the layout component. So, the framework needs to know where the component projected output should be inserted. Qwik needs a virtual node for that.
8989
- `<!--qv q:id=7 q:key=xYL1:zl_0-->`: This virtual node represents the Counter component. The component requires component props, which are stored in the data section (`<script type="qwik/json">`). The additional attributes are used to cross-reference the props with this virtual node. A key point of resumability is that one should be able to re-render a component without the parent component needing to be resumed as well. But components get props from the parent, so the props need to be serialized and recoverable so that this component can render independently of others. Qwik needs a virtual node for that.
9090
- `<!--qv q:key=H1_0-->`: The Counter component JSX has a top-level Fragment represented by `<>...</>`. Qwik needs a virtual node for that.
9191
- `<!--t=8-->123<!---->`: When the counter updates, Qwik needs to be able to update the text node associated with the signal. HTML merges neighboring text nodes, and there is no easy way to refer to text nodes. So Qwik needs a virtual node for that.

packages/docs/src/routes/(blog)/blog/(articles)/qwik-city-server-functions/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ In the context of Qwik City, the problem becomes a little bit more complicated t
7373

7474
Qwik's Data Loader solves the issue of quickly fetching data to be displayed in the HTML. It helps to ensure that the data is available in a timely manner. This helps to improve the user experience and reduce loading times.
7575

76-
Qwik City goes a long way to execute all relevant loaders as soon as possible and in parallel to keep latency as low as possible, in addition, loaders are connected to the reactivity system of Qwik powered by [signals](https://qwik.dev/docs/components/state/#usesignal), so new data will automatically and efficiently update all parts of the app that depend on it.
76+
Qwik City goes a long way to execute all relevant loaders as soon as possible and in parallel to keep latency as low as possible, in addition, loaders are connected to the reactivity system of Qwik powered by [signals](https://qwik.dev/docs/core/state/#usesignal), so new data will automatically and efficiently update all parts of the app that depend on it.
7777

7878
```tsx
7979
import { loader$ } from '@builder.io/qwik-city';

packages/docs/src/routes/(blog)/blog/(articles)/qwik-tasks/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The JavaScript that's sent is extremely minimal — bite-size amounts of code ge
3535

3636
## Using visible tasks in Qwik
3737

38-
With Qwik, this takes no extra work. All we need is this [useVisibleTask$](https://qwik.dev/docs/components/tasks/#usevisibletask) hook.
38+
With Qwik, this takes no extra work. All we need is this [useVisibleTask$](https://qwik.dev/docs/core/tasks/#usevisibletask) hook.
3939

4040
```jsx
4141
import { component$, useSignal, useVisibleTask$ } from "@builder.io/qwik";

packages/docs/src/routes/(blog)/blog/(articles)/the-qase-for-qwik-love-at-first-tti/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ This is the result:
263263
264264
What we’ve done is create a simple counter component inside a [QwikCity](https://qwik.dev/qwikcity/overview/) project, which is the meta-framework for Qwik. Basically, it’s like SvelteKit for Svelte, or [SolidStart](https://start.solidjs.com/getting-started/what-is-solidstart) for Solid. It is generally in charge of routing and the build.
265265

266-
If you're coming from React (or Solid), you can see that a lot of the above looks familiar. As Qwik uses JSX, you should feel right at home. A [signal](https://qwik.dev/docs/components/state/#usesignal) is a reactive piece of state, similar to [Solid.js signals](https://www.solidjs.com/tutorial/introduction_signals), which consists of an object with a single property (`signal.value`) that when changed will update any component that uses it. Similarly, `useStore` is almost the same as a signal but accepts an object as a parameter, that then becomes reactive.
266+
If you're coming from React (or Solid), you can see that a lot of the above looks familiar. As Qwik uses JSX, you should feel right at home. A [signal](https://qwik.dev/docs/core/state/#usesignal) is a reactive piece of state, similar to [Solid.js signals](https://www.solidjs.com/tutorial/introduction_signals), which consists of an object with a single property (`signal.value`) that when changed will update any component that uses it. Similarly, `useStore` is almost the same as a signal but accepts an object as a parameter, that then becomes reactive.
267267

268268
The second thing to notice is the `$` sign after `component$` and `onClick$`, which is [a symbol in Qwik.](https://qwik.dev/docs/advanced/dollar/) These are hints for the optimizer to break our code into pieces that can later be loaded intelligently. It’s important to note that only serializable data can be used in a lazy-loaded boundary.
269269

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Limitations of JSON that Qwik does not solve:
108108
- Although some built-in classes, such as [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date), [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL), [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map), [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) are supported.
109109
- Serialization of Streams.
110110

111-
For cases where serialization is not possible, code should run [on client only](https://qwik.dev/docs/components/lifecycle/#serverbrowser-only-task).
111+
For cases where serialization is not possible, code should run [on client only](https://qwik.dev/docs/core/lifecycle/#serverbrowser-only-task).
112112

113113
### Writing applications with serializability in mind
114114

File renamed without changes.

0 commit comments

Comments
 (0)