Skip to content

Commit

Permalink
docs: update page titles / positions in docs (#727)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsekiguchi authored Jan 9, 2025
1 parent ab498f7 commit 9fbb988
Show file tree
Hide file tree
Showing 26 changed files with 25 additions and 106 deletions.
2 changes: 1 addition & 1 deletion docs/docs/examples/broadcast.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Broadcast
sidebar_position: 23
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/electron.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: Worker Options
id: Electron
sidebar_position: 4
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/es-module.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: ES Module
sidebar_position: 3
sidebar_position: 5
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/message-port.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Message Port
sidebar_position: 4
sidebar_position: 6
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/messages.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Messages
sidebar_position: 5
sidebar_position: 7
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/move.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Move
sidebar_position: 6
sidebar_position: 8
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/multiple-workers-one-file.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Multiple Workers in One File
sidebar_position: 8
sidebar_position: 9
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/multiple-workers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Multiple Workers
sidebar_position: 7
sidebar_position: 10
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/n-api.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: N-API Native Addon
sidebar_position: 9
sidebar_position: 11
---

For CPU-intensive tasks or when implementing workers in languages such as C++ or Rust, you can leverage Piscina's support for native addons as worker implementations.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/named.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Named Tasks
sidebar_position: 10
sidebar_position: 12
---

import { WorkerWrapperComponent } from "@site/src/components/WorkerWrapper.mdx";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/progress.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Progress
sidebar_position: 11
sidebar_position: 13
---

import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/react-ssr.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: React Server Side Rendering
sidebar_position: 12
sidebar_position: 14
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/resource-limit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Resource Limits
sidebar_position: 12
sidebar_position: 15
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/scrypt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Scrypt
sidebar_position: 13
sidebar_position: 16
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/server.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Server
sidebar_position: 14
sidebar_position: 17
---

The benefit of offloading work to a worker pool will vary significantly
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/simple.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Simple
sidebar_position: 15
sidebar_position: 19
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/simple_async.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Simple Async
sidebar_position: 16
sidebar_position: 18
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/stream-in.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Stream-In
sidebar_position: 17
sidebar_position: 20
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/stream.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Stream
sidebar_position: 16
sidebar_position: 21
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/task-queue.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Task Queue
sidebar_position: 18
sidebar_position: 22
---

import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
Expand Down
81 changes: 0 additions & 81 deletions docs/docs/examples/typescript.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/examples/webstreams-transform.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Web Streams Transfer
sidebar_position: 21
sidebar_position: 24
---

import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/webstreams.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Web Streams
sidebar_position: 20
sidebar_position: 25
---

import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/examples/worker-options.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Worker Options
sidebar_position: 22
sidebar_position: 26
---

import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/managing-worker-threads.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Managing Worker Threads
sidebar_position: 2
sidebar_position: 3
---
import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';
import Tabs from "@theme/Tabs";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Typescript
sidebar_position: 19
sidebar_position: 4
---
import {WorkerWrapperComponent} from '@site/src/components/WorkerWrapper.mdx';

Expand Down

0 comments on commit 9fbb988

Please sign in to comment.