Skip to content

Commit f32b3b0

Browse files
authored
docs: Improve site metadata for SEO (#3135)
1 parent 7bd322d commit f32b3b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+243
-198
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,5 @@ typings/
7272

7373
# build info
7474
**/tsconfig*.tsbuildinfo
75+
76+
/codemods/

docs/core/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: The Reactive Data Client
2+
title: Introducing the Reactive Data Client
33
sidebar_label: Introduction
4+
description: Building delightful dynamic applications with NextJS, Expo, React Native and more.
45
slug: /
56
---
67

@@ -14,10 +15,10 @@ import HooksPlayground from '@site/src/components/HooksPlayground';
1415
import Link from '@docusaurus/Link';
1516

1617
<head>
17-
<title>Introducing the Reactive Data Client</title>
1818
<meta name="docsearch:pagerank" content="10"/>
1919
</head>
2020

21+
# The Reactive Data Client
2122

2223
Reactive Data Client provides safe and performant [client access](./api/useSuspense.md) and [mutation](./api/Controller.md#fetch) over [remote data protocols](https://www.freecodecamp.org/news/what-is-an-api-in-english-please-b880a3214a82/).
2324
Both pull/fetch ([REST](/rest) and [GraphQL](/graphql)) and push/stream ([WebSockets or Server Sent Events](./api/Manager.md#data-stream)) can be used simultaneously.

docs/core/api/AsyncBoundary.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
---
2-
title: '<AsyncBoundary />'
2+
title: AsyncBoundary - Centralize loading and error handling
3+
sidebar_label: <AsyncBoundary />
4+
description: Handles loading and error conditions of Suspense.
35
---
46

57
<head>
6-
<title>AsyncBoundary - Centralize loading and error handling</title>
78
<meta name="docsearch:pagerank" content="20"/>
89
</head>
910

11+
# &lt;AsyncBoundary />
12+
1013
Handles loading and error conditions of Suspense.
1114

1215
In React 18, this will create a [concurrent split](https://react.dev/reference/react/useTransition), and in 16 and 17 it will show loading fallbacks. If there is an irrecoverable error, it will show an error fallback.

docs/core/api/Controller.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Controller
2+
title: Controller - Typesafe imperative store access
3+
sidebar_label: Controller
34
---
45

56
<head>
6-
<title>Controller - Typesafe imperative store access</title>
77
<meta name="docsearch:pagerank" content="30"/>
88
</head>
99

@@ -12,6 +12,8 @@ import Tabs from '@theme/Tabs';
1212
import TabItem from '@theme/TabItem';
1313
import StackBlitz from '@site/src/components/StackBlitz';
1414

15+
# Controller
16+
1517
`Controller` is a singleton providing safe access to the Reactive Data Client [flux store and lifecycle](./Manager.md#control-flow).
1618
`Controller` memoizes all store access, allowing a global referential equality guarantee and the fastest rendering
1719
and retrieval performance.

docs/core/api/DataProvider.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: '<DataProvider />'
2+
title: DataProvider - Normalized async data management in React
3+
sidebar_label: <DataProvider />
4+
description: High performance, globally consistent data management in React
35
---
46

5-
<head>
6-
<title>DataProvider - Normalized async data management in React</title>
7-
</head>
8-
97
import Installation from '../shared/\_installation.mdx';
108
import Tabs from '@theme/Tabs';
119
import TabItem from '@theme/TabItem';
1210

11+
# &lt;DataProvider />
12+
1313
Manages state, providing all context needed to use the hooks. Should be placed as high as possible
1414
in application tree as any usage of the hooks is only possible for components below the provider
1515
in the React tree.

docs/core/api/Fixtures.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
2-
title: Fixtures and Interceptors
2+
title: 'Fixtures and Interceptors: declarative data mocking for tests and stories'
33
sidebar_label: Fixtures and Interceptors
4+
description: Fixtures and Interceptors allow universal data mocking without the need for monkeypatching fetch behaviors.
45
---
56

6-
<head>
7-
<title>Fixtures and Interceptors: declarative data mocking for tests and stories</title>
8-
</head>
9-
107
import GenericsTabs from '@site/src/components/GenericsTabs';
118

9+
# Fixtures and Interceptors
10+
1211
Fixtures and Interceptors allow universal data mocking without the need for monkeypatching
1312
fetch behaviors. Fixtures define static responses to specific endpoint arg combinations. This
1413
allows them to be used in static contexts like [mockInitialState()](./mockInitialState.md).

docs/core/api/LogoutManager.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
title: 'LogoutManager'
2+
title: LogoutManager - Handling 401s and other deauthorization triggers
33
sidebar_label: LogoutManager
44
---
55

66
import Tabs from '@theme/Tabs';
77
import TabItem from '@theme/TabItem';
88
import StackBlitz from '@site/src/components/StackBlitz';
99

10-
<head>
11-
<title>LogoutManager - Handling 401s and other deauthorization triggers</title>
12-
</head>
10+
# LogoutManager
1311

1412
Logs out based on fetch responses. By default this is triggered by [401 (Unauthorized)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401) status responses.
1513

docs/core/api/Manager.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Manager
2+
title: Manager - Powerful middlewares with global store knowledge
3+
sidebar_label: Manager
34
---
45

56
import Tabs from '@theme/Tabs';
@@ -8,10 +9,11 @@ import ThemedImage from '@theme/ThemedImage';
89
import useBaseUrl from '@docusaurus/useBaseUrl';
910

1011
<head>
11-
<title>Manager - Powerful middlewares with global store knowledge</title>
1212
<meta name="docsearch:pagerank" content="20"/>
1313
</head>
1414

15+
# Manager
16+
1517
Managers are singletons that orchestrate the complex asynchronous behavior of `Reactive Data Client`.
1618
Several managers are provided by `Reactive Data Client` and used by default; however there is nothing
1719
stopping other compatible managers to be built that expand the functionality. We encourage

docs/core/api/MockResolver.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
title: '<MockResolver />'
2+
title: MockResolver - Data Mocking for React
3+
sidebar_label: <MockResolver />
34
---
45

5-
<head>
6-
<title>MockResolver - Data Mocking for React</title>
7-
</head>
6+
# &lt;MockResolver />
87

98
```typescript
109
function MockResolver<T>(props: {

docs/core/api/NetworkManager.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
title: NetworkManager
2+
title: NetworkManager - Orchestrating efficient race-condition free fetching
33
sidebar_label: NetworkManager
44
---
55

6-
<head>
7-
<title>NetworkManager - Orchestrating efficient race-condition free fetching</title>
8-
</head>
9-
6+
# NetworkManager
107

118
NetworkManager orchestrates asynchronous fetches. By keeping track of all in-flight requests
129
it is able to dedupe identical requests if they are made using the throttle flag.

0 commit comments

Comments
 (0)