Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: reworded documentation and fixed grammar #6207

Merged
merged 2 commits into from
May 2, 2024
Merged

docs: reworded documentation and fixed grammar #6207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42b004a
docs(src/routes/api/qwik/index.md): reworded documentation and fixed …
codyroberts May 2, 2024
c941cd5
Discard changes to packages/docs/src/routes/api/qwik/api.json
PatrickJS May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/docs/src/routes/api/qwik/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1515,9 +1515,9 @@ A unique ID for the context.

Low-level API for platform abstraction.

Different platforms (browser, node, service workers) may have different ways of handling things such as `requestAnimationFrame` and imports. To make Qwik platform-independent Qwik uses the `CorePlatform` API to access the platform API.
Different platforms (browser, node, service workers) may have different ways of handling things such as `requestAnimationFrame` and imports. To make Qwik platform independent, the `CorePlatform` API is used to access platform specific APIs.

`CorePlatform` also is responsible for importing symbols. The import map is different on the client (browser) then on the server. For this reason, the server has a manifest that is used to map symbols to javascript chunks. The manifest is encapsulated in `CorePlatform`, for this reason, the `CorePlatform` can't be global as there may be multiple applications running at server concurrently.
`CorePlatform` is also responsible for importing symbols. Because the import map is different on the client (browser) than on the server, the server uses a manifest to map symbols to javascript chunks. Since this manifest is encapsulated in `CorePlatform`, `CorePlatform` cannot be global as there may be multiple applications running on the server concurrently.

This is a low-level API and there should not be a need for you to access this.

Expand Down Expand Up @@ -1694,7 +1694,7 @@ Create a context ID to be used in your application. The name should be written w

Context is a way to pass stores to the child components without prop-drilling.

Use `createContextId()` to create a `ContextId`. A `ContextId` is just a serializable identifier for the context. It is not the context value itself. See `useContextProvider()` and `useContext()` for the values. Qwik needs a serializable ID for the context so that the it can track context providers and consumers in a way that survives resumability.
Use `createContextId()` to create a `ContextId`. A `ContextId` is just a serializable identifier for the context. It is not the context value itself. See `useContextProvider()` and `useContext()` for the values. Qwik needs a serializable ID for the context so that it can track context providers and consumers in a way that survives resumability.

### Example

Expand Down Expand Up @@ -3520,7 +3520,7 @@ _(Optional)_ Options for the loading prefetch graph.
</tbody></table>
**Returns:**

import("@builder.io/qwik/jsx-runtime").[JSXNode](#jsxnode)&lt;"script"&gt;
import("@builder.io/qwik/jsx-runtime").JSXNode&lt;"script"&gt;

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts)

Expand Down Expand Up @@ -3572,7 +3572,7 @@ Options for the prefetch service worker.
</tbody></table>
**Returns:**

import("@builder.io/qwik/jsx-runtime").[JSXNode](#jsxnode)&lt;"script"&gt;
import("@builder.io/qwik/jsx-runtime").JSXNode&lt;"script"&gt;

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts)

Expand Down
Loading