Skip to content

Commit d5a9f72

Browse files
committed
docs: update documentation links to use relative paths for consistency
1 parent 64de51f commit d5a9f72

28 files changed

Lines changed: 152 additions & 152 deletions

website/docs/authorization/qraft-secure-request-fn.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ type SecurityScheme =
8686

8787
## Supported Security Schemes
8888

89-
- [x] [Bearer](/authorization/bearer-authentication.mdx)
90-
- [x] [API Key](/authorization/api-key-authentication.mdx)
91-
- [x] [Basic](/authorization/basic-authentication.mdx)
92-
- [x] [Cookie](/authorization/cookie-authentication.mdx)
89+
- [x] [Bearer](./bearer-authentication.mdx)
90+
- [x] [API Key](./api-key-authentication.mdx)
91+
- [x] [Basic](./basic-authentication.mdx)
92+
- [x] [Cookie](./cookie-authentication.mdx)
9393
- [ ] OAuth2 (_[create an issue](https://github.com/OpenAPI-Qraft/openapi-qraft/issues/new)_)
9494

9595
## Example

website/docs/codegen/asyncapi/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ npx qraft asyncapi --plugin asyncapi-typescript ./asyncapi.yaml --output-dir src
3939
- `--redocly`
4040
- `--redocly ./my-redocly-config.yaml`
4141
- `qraft asyncapi events --redocly`
42-
- For more information about this option, use the command: `--redocly-help` or [read the docs](/codegen/cli/redocly-config.mdx).
42+
- For more information about this option, use the command: `--redocly-help` or [read the docs](../cli/redocly-config.mdx).
4343
- **`--plugin <name_1> --plugin <name_2>`**: Generator plugins to be used. (choices: `asyncapi-typescript`)
4444
- Example: `--plugin asyncapi-typescript`
4545
- **`-h, --help`**: Display help for the command.

website/docs/codegen/cli/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_label: CLI overview
99

1010
It supports **two generation modes**:
1111

12-
- **[OpenAPI mode](/codegen/openapi/index.mdx)** (`qraft openapi`) — generates code from OpenAPI documents with OpenAPI plugins.
13-
- **[AsyncAPI mode](/codegen/asyncapi/index.mdx)** (`qraft asyncapi`) — enables generation from AsyncAPI documents with AsyncAPI plugins.
12+
- **[OpenAPI mode](../openapi/index.mdx)** (`qraft openapi`) — generates code from OpenAPI documents with OpenAPI plugins.
13+
- **[AsyncAPI mode](../asyncapi/index.mdx)** (`qraft asyncapi`) — enables generation from AsyncAPI documents with AsyncAPI plugins.
1414

1515
This lets you use one CLI package and one binary (`qraft`) for both OpenAPI and AsyncAPI schemas.

website/docs/codegen/cli/redocly-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ apis:
210210

211211
Qraft allows you to generate multiple _create API client functions_ with different parameters using the `--create-api-client-fn`
212212
option. This is particularly useful when you need to create specialized clients for different environments or use cases.
213-
For more information on using options, please explore the [CLI documentation](/codegen/cli/index.mdx).
213+
For more information on using options, please explore the [CLI documentation](./index.mdx).
214214

215215
Here's an example of how to configure multiple _create API client functions_:
216216

website/docs/codegen/openapi/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ which is a powerful tool for generating types from an OpenAPI schema.
1616

1717
:::tip
1818

19-
If you missed the [installation](/getting-started/installation.mdx) step, you can install the unified `@qraft/cli` package and OpenAPI plugins:
19+
If you missed the [installation](../../getting-started/installation.mdx) step, you can install the unified `@qraft/cli` package and OpenAPI plugins:
2020

2121
```bash npm2yarn
2222
npm install -D @qraft/cli @openapi-qraft/tanstack-query-react-plugin @openapi-qraft/openapi-typescript-plugin
@@ -100,7 +100,7 @@ npx qraft openapi --plugin tanstack-query-react --plugin openapi-typescript http
100100
- `--redocly` - use the default Redocly configuration file
101101
- `--redocly ./my-redocly-config.yaml` - use a custom Redocly configuration file
102102
- `qraft openapi my-api@v1 external-api --redocly` - generate clients for multiple APIs defined in the Redocly configuration
103-
- For more information about this option, use the command: `--redocly-help` or [read the docs](/codegen/cli/redocly-config.mdx).
103+
- For more information about this option, use the command: `--redocly-help` or [read the docs](../cli/redocly-config.mdx).
104104

105105
- **`--service-name-base <endpoint[<index>] | tags>`:** Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: `/0/1/2`) or `tags` as the base name of the service. _(optional, default: `endpoint[0]`)_.
106106
- **`endpoint[<index>]`** - Use the path segment (e.g., `/0/1/2`) as the base name for the service.
@@ -195,7 +195,7 @@ It is possible to use multiple plugins at the same time. For example, `--plugin
195195
- **`--create-api-client-fn <functionName> [options...]`:** Configure API client creation function. Allows specifying the function name used to create the API client, as well as fine-tuning included services and callbacks.
196196
You can specify this option **multiple times** to generate **several different API client** creation functions from a single OpenAPI document - for example,
197197
a fully-featured client for Node.js and a lightweight client for React or service workers. _(optional)_
198-
See examples on the [`useQuery()`](/hooks/useQuery.mdx#example) documentation page.
198+
See examples on the [`useQuery()`](../../hooks/useQuery.mdx#example) documentation page.
199199
- **Options:**
200200
- `filename:<name>` - filename where the function will be generated (defaults to function name)
201201
- `services:[all|none]` - Specify whether the generated API client should include services: either all available services, or no services by default.
@@ -216,7 +216,7 @@ It is possible to use multiple plugins at the same time. For example, `--plugin
216216

217217
::::tip
218218
When generating multiple API client functions with different parameters, it might be more convenient to use a configuration file
219-
instead of command-line parameters. See the [Redocly configuration documentation](/codegen/cli/redocly-config.mdx#generating-multiple-api-client-functions)
219+
instead of command-line parameters. See the [Redocly configuration documentation](../cli/redocly-config.mdx#generating-multiple-api-client-functions)
220220
for more details on how to configure multiple _create API client functions_ in a YAML file.
221221
::::
222222

website/docs/guides/directus-integration.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ npm install @tanstack/react-query
4848

4949
:::info
5050

51-
For more details on installation, see the [Installation guide](/getting-started/installation.mdx).
51+
For more details on installation, see the [Installation guide](../getting-started/installation.mdx).
5252

5353
:::
5454

@@ -119,7 +119,7 @@ apis:
119119

120120
:::tip
121121

122-
For more information about Redocly configuration options, see the [Redocly config support](/codegen/cli/redocly-config.mdx) documentation.
122+
For more information about Redocly configuration options, see the [Redocly config support](../codegen/cli/redocly-config.mdx) documentation.
123123

124124
:::
125125

@@ -290,7 +290,7 @@ npx openapi-qraft \
290290

291291
:::info
292292

293-
For a complete list of CLI options, see the [CLI documentation](/codegen/cli/index.mdx).
293+
For a complete list of CLI options, see the [CLI documentation](../codegen/cli/index.mdx).
294294

295295
:::
296296

@@ -523,6 +523,6 @@ apis:
523523

524524
## Next Steps
525525

526-
- Learn more about [Redocly configuration](/codegen/cli/redocly-config.mdx)
527-
- Explore [CLI options](/codegen/cli/index.mdx) for advanced customization, including the `--operation-parameters-type-wrapper` option
528-
- Check out the [Quick Start guide](/getting-started/quick-start.mdx) for general usage patterns
526+
- Learn more about [Redocly configuration](../codegen/cli/redocly-config.mdx)
527+
- Explore [CLI options](../codegen/cli/index.mdx) for advanced customization, including the `--operation-parameters-type-wrapper` option
528+
- Check out the [Quick Start guide](../getting-started/quick-start.mdx) for general usage patterns

website/docs/hooks/useQuery.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ during code generation.
107107
</TabItem>
108108
<TabItem value="query-key" label={<span style={{verticalAlign: 'middle'}}>by <code>QueryKey</code></span>}>
109109
Using the Query Key (array) as an arguments for the `useQuery` is useful
110-
with combination of [`api.<service>.<operation>.getQueryKey(...)`](/query-client/getQueryKey.mdx) method
110+
with combination of [`api.<service>.<operation>.getQueryKey(...)`](../query-client/getQueryKey.mdx) method
111111
when shared Query Key is needed.
112112

113113
```tsx title="src/ApprovalPolicyName.tsx"
@@ -272,7 +272,7 @@ during code generation.
272272
You can specify which services and callback functions should be included in the client by default.
273273

274274
> 💡 When generating multiple API client functions with different parameters, it might be more convenient to use a configuration file
275-
> instead of command-line parameters. See the [Redocly configuration documentation](/codegen/cli/redocly-config.mdx#generating-multiple-api-client-functions)
275+
> instead of command-line parameters. See the [Redocly configuration documentation](../codegen/cli/redocly-config.mdx#generating-multiple-api-client-functions)
276276
> for more details on how to configure multiple _create API client functions_ in a YAML file.
277277
278278
#### Example 1: All services but no callbacks by default

website/docs/hooks/useSuspenseInfiniteQuery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: useSuspenseInfiniteQuery()
55
# useSuspenseInfiniteQuery(...)
66

77
The Hook enables you to perform asynchronous data fetching operations with support for infinite scrolling scenarios.
8-
The functionality is similar to the [_useInfiniteQuery_](/hooks/useInfiniteQuery.mdx) hook, but with the added benefit
8+
The functionality is similar to the [_useInfiniteQuery_](./useInfiniteQuery.mdx) hook, but with the added benefit
99
of Suspense support.
1010
For more detailed information, explore [_useSuspenseInfiniteQuery(...) 🌴_](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseInfiniteQuery) documentation for more details.
1111

website/docs/hooks/useSuspenseQueries.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: useSuspenseQueries()
77
See the [_useSuspenseQueries(...) 🌴_](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQueries) documentation.
88

99
The Hook enables you to concurrently execute multiple asynchronous data fetching operations.
10-
The functionality is similar to the [_useQueries_](/hooks/useQueries.mdx) hook, but with the added benefit of Suspense support.
10+
The functionality is similar to the [_useQueries_](./useQueries.mdx) hook, but with the added benefit of Suspense support.
1111
For more detailed information, explore the TanStack
1212
[_useSuspenseQueries(...) 🌴_](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQueries) documentation.
1313

website/docs/hooks/useSuspenseQuery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: useSuspenseQuery()
77
See the [_useSuspenseQuery(...) 🌴_](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQuery) documentation.
88

99
The Hook enables you to perform asynchronous data fetching operations,
10-
similar to [_useQuery_](/hooks/useQuery.mdx) Hook, but with the added benefit of Suspense support.
10+
similar to [_useQuery_](./useQuery.mdx) Hook, but with the added benefit of Suspense support.
1111
See the TanStack [_useSuspenseQuery(...) 🌴_](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQuery)
1212
documentation for more details.
1313

0 commit comments

Comments
 (0)