Skip to content

Commit

Permalink
docs: RDC -> Data Client as abbreviation
Browse files Browse the repository at this point in the history
  • Loading branch information
ntucker committed May 7, 2024
1 parent cd04083 commit bfc5338
Show file tree
Hide file tree
Showing 20 changed files with 766 additions and 7,875 deletions.
2 changes: 1 addition & 1 deletion docs/core/concepts/managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ characterized by an easy to [understand and debug](../guides/debugging.md) the s

In flux architectures, it is critical all functions in the flux loop are [pure](https://react.dev/learn/keeping-components-pure).
Managers provide centralized orchestration of side effects. In other words, they are the means to interface
with the world outside RDC.
with the world outside <abbr title="Reactive Data Client">Data Client</abbr>.

For instance, [NetworkManager](../api/NetworkManager.md) orchestrates data fetching and [SubscriptionManager](../api/SubscriptionManager.md)
keeps track of which resources are subscribed with [useLive](../api/useLive.md) or [useSubscription](../api/useSubscription.md). By centralizing control, [NetworkManager](../api/NetworkManager.md) automatically deduplicates fetches, and [SubscriptionManager](../api/SubscriptionManager.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/core/concepts/normalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ can be installed to inspect and [debug the store](../guides/debugging.md).

<center>

<Link className="button button--secondary" to="../guides/debugging">RDC Debugging Guide »</Link>
<Link className="button button--secondary" to="../guides/debugging">Data Client Debugging Guide »</Link>

</center>

Expand All @@ -409,15 +409,15 @@ and up to 20x performance even after [mutation operations](../getting-started/mu
```mermaid
xychart-beta
title "Denormalize Single Entity"
x-axis [normalizr, "RDC", "RDC (cached)"]
x-axis [normalizr, "Data Client", "Data Client (cached)"]
y-axis "Operations per second" 0 --> 4875500
bar [218500, 1079500, 4875500]
```

```mermaid
xychart-beta
title "Denormalize Large List"
x-axis [normalizr, "RDC", "RDC (cached)"]
x-axis [normalizr, "Data Client", "Data Client (cached)"]
y-axis "Operations per second" 0 --> 12962
bar [1165, 1807, 13168]
```
Expand Down
2 changes: 1 addition & 1 deletion docs/core/getting-started/mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ render(<TodoList />);
</HooksPlayground>

Rather than triggering invalidation cascades or using manually written update functions,
<abbr title="Reactive Data Client">RDC</abbr> reactively updates appropriate components using the fetch response.
<abbr title="Reactive Data Client">Data Client</abbr> reactively updates appropriate components using the fetch response.

## Optimistic mutations based on previous state {#optimistic-updates}

Expand Down
2 changes: 1 addition & 1 deletion docs/core/getting-started/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export const TodoResource = {

<PkgInstall pkgs="@data-client/endpoint" />

Pre-existing TypeScript definitions can be used in <abbr title="Reactive Data Client">RDC</abbr> with
Pre-existing TypeScript definitions can be used in <abbr title="Reactive Data Client">Data Client</abbr> with
[Endpoint](/rest/api/Endpoint) and [schema.Entity](/rest/api/schema.Entity).

<TypeScriptEditor row={false}>
Expand Down
2 changes: 1 addition & 1 deletion docs/core/guides/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';

RDC uses the [flux store](https://facebookarchive.github.io/flux/docs/in-depth-overview/) pattern, making debugging
<abbr title="Reactive Data Client">Data Client</abbr> uses the [flux store](https://facebookarchive.github.io/flux/docs/in-depth-overview/) pattern, making debugging
straightforward as each change is traceable and descriptive.

<ThemedImage
Expand Down
2 changes: 1 addition & 1 deletion docs/core/shared/_conditional_dependencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import CodeBlock from '@theme/CodeBlock';

:::tip Conditional Dependencies

Use `null` as the second argument to any <abbr title="Reactive Data Client">RDC</abbr> hook means "do nothing."
Use `null` as the second argument to any <abbr title="Reactive Data Client">Data Client</abbr> hook means "do nothing."

<CodeBlock
language="typescript">
Expand Down
4 changes: 2 additions & 2 deletions docs/rest/guides/optimistic-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ function ensureBodyPojo(body: any) {
```

For creates (push/unshift) this typically results in no `id` in the response to compute a pk.
RDC will create a random `pk` to make this work.
<abbr title="Reactive Data Client">Data Client</abbr> will create a random `pk` to make this work.

Until the object is actually created, doing mutations on that object generally does not work.
Therefore, it may be prudent in these cases to disable further mutations until the actual
Expand Down Expand Up @@ -358,7 +358,7 @@ function CounterPage() {
us.
</p>
<div>
RDC: {count} Should be: {n}
Data Client: {count} Should be: {n}
<br />
<button onClick={clickHandler}>+</button>
{loading ? ' ...loading' : ''}
Expand Down
2 changes: 1 addition & 1 deletion docs/rest/shared/_optimisticTransform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ function CounterPage() {
</thead>
<tbody>
<tr>
<th><abbr title="Reactive Data Client">RDC</abbr>:</th>
<th><abbr title="Reactive Data Client">Data Client</abbr>:</th>
<td>{count}</td>
<td></td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion examples/github-app/src/navigation/LoginModal.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Button, Modal } from 'antd';
import { Modal } from 'antd';
import { useCallback, useContext } from 'react';

import { authdContext } from './authdContext';
Expand Down
2 changes: 1 addition & 1 deletion examples/github-app/src/navigation/NavBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function NavBar() {
name="IssueList"
props={{ repo: 'data-client', owner: 'reactive' }}
>
RDC Issues
Data Client Issues
</Link>
),
},
Expand Down
2 changes: 1 addition & 1 deletion examples/github-app/src/pages/IssueDetail/ReactionSpan.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useSuspense, useController, useCache } from '@data-client/react';
import { useController, useCache } from '@data-client/react';
import { Tag } from 'antd';
import React, { useCallback } from 'react';
import { Issue } from 'resources/Issue';
Expand Down
2 changes: 1 addition & 1 deletion examples/github-app/src/pages/IssuesPage.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Link, useLocationSearch } from '@anansi/router';
import { HomeOutlined, UserOutlined } from '@ant-design/icons';
import { HomeOutlined } from '@ant-design/icons';
import { Breadcrumb } from 'antd';
import { Issue } from 'resources/Issue';

Expand Down
14 changes: 7 additions & 7 deletions examples/github-app/src/resources/Push.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { GithubEntity } from './Base';

export class Push extends GithubEntity {
readonly pushId: number = -1;
readonly size: number = 0;
readonly distinctSize: number = 0;
readonly ref: string = '';
readonly head: string = '';
readonly before: string = '';
readonly commits: Commit[] = [];
pushId = -1;
size = 0;
distinctSize = 0;
ref = '';
head = '';
before = '';
commits: Commit[] = [];

pk() {
return `${this.pushId}`;
Expand Down
6 changes: 3 additions & 3 deletions examples/github-app/src/resources/Reaction.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import PreviewEndpoint from './PreviewEndpoint';
import { User } from './User';

export class Reaction extends GithubEntity {
readonly user: User = User.fromJS();
readonly content: ReactionType = '+1';
readonly createdAt = Temporal.Instant.fromEpochSeconds(0);
user = User.fromJS();
content: ReactionType = '+1';
createdAt = Temporal.Instant.fromEpochSeconds(0);

get contentIcon() {
return contentToIcon[this.content];
Expand Down

0 comments on commit bfc5338

Please sign in to comment.