Skip to content

Commit 0c826c2

Browse files
committed
docs: guides/debugging -> getting-started/debugging
1 parent 2d9911c commit 0c826c2

File tree

16 files changed

+30
-15
lines changed

16 files changed

+30
-15
lines changed

.changeset/real-ties-trade.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
'@data-client/endpoint': patch
3+
'@data-client/react': patch
4+
'@data-client/graphql': patch
5+
'@data-client/rest': patch
6+
---
7+
8+
Update debugging link

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ A clear and concise description of what you expected to happen.
3434
Include anything that could be related:
3535
- Console errors and warnings
3636
- [Network inspector](https://developer.chrome.com/docs/devtools/network/) screenshots
37-
- [Browser Devtools](https://dataclient.io/docs/guides/debugging) screenshots or state and action dumps
37+
- [Browser Devtools](https://dataclient.io/docs/getting-started/debugging) screenshots or state and action dumps
3838

3939
**Minimum reproducable example or test case**
4040
For many cases reproducing the bug is fairly straightforward. However, if

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
why you expected it.
99
* Include any relevant stack traces or debugging output.
1010
* Ensure you captured relevant [network inspector](https://developer.chrome.com/docs/devtools/network/) screenshots
11-
* Ensure [Browser Devtools](https://dataclient.io/docs/guides/debugging) screenshots or state and action dumps
11+
* Ensure [Browser Devtools](https://dataclient.io/docs/getting-started/debugging) screenshots or state and action dumps
1212

1313
## Feature Requests
1414

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ For the small price of 9kb gziped.    [🏁Get started now](https://da
229229
- [x] 🛑 Automatic overfetching elimination
230230
- [x] ✨ Fast [optimistic updates](https://dataclient.io/rest/guides/optimistic-updates)
231231
- [x] 🧘 [Flexible](https://dataclient.io/docs/getting-started/resource) to fit any API design (one size fits all)
232-
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/guides/debugging) via browser extension
232+
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/getting-started/debugging) via browser extension
233233
- [x] 🌳 Tree-shakable (only use what you need)
234234
- [x] 🔁 [Subscriptions](https://dataclient.io/docs/api/useSubscription)
235235
- [x] ♻️ Optional [redux integration](https://dataclient.io/docs/guides/redux)

docs/core/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ Add the Redux DevTools for
502502
or
503503
[firefox extension](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/)
504504

505-
Click the icon to open the [inspector](./guides/debugging.md), which allows you to observe dispatched actions,
505+
Click the icon to open the [inspector](./getting-started/debugging.md), which allows you to observe dispatched actions,
506506
their effect on the cache state as well as current cache state.
507507

508508
## Mock data

docs/core/api/DevToolsManager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ ReactDOM.createRoot(document.body).render(
9595

9696
## More info
9797

98-
Using this Manager allows in browser [debugging and store inspection](../guides/debugging).
98+
Using this Manager allows in browser [debugging and store inspection](../getting-started/debugging.md).

docs/core/concepts/managers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import StackBlitz from '@site/src/components/StackBlitz';
1616
# Managers and Middleware
1717

1818
Reactive Data Client uses the [flux store](https://facebookarchive.github.io/flux/docs/in-depth-overview/) pattern, which is
19-
characterized by an easy to [understand and debug](../guides/debugging.md) the store's [undirectional data flow](<https://en.wikipedia.org/wiki/Unidirectional_Data_Flow_(computer_science)>). State updates are performed by a [reducer function](https://github.com/reactive/data-client/blob/master/packages/core/src/state/reducer/createReducer.ts#L19).
19+
characterized by an easy to [understand and debug](../getting-started/debugging.md) the store's [undirectional data flow](<https://en.wikipedia.org/wiki/Unidirectional_Data_Flow_(computer_science)>). State updates are performed by a [reducer function](https://github.com/reactive/data-client/blob/master/packages/core/src/state/reducer/createReducer.ts#L19).
2020

2121
<ThemedImage
2222
alt="Manager flux flow"
@@ -42,7 +42,7 @@ They can also be customized to change core behaviors.
4242
| ---------------------------------------------------- | ------------------------------------------------------------------------------------ |
4343
| [NetworkManager](../api/NetworkManager.md) | Turns fetch dispatches into network calls |
4444
| [SubscriptionManager](../api/SubscriptionManager.md) | Handles polling [subscriptions](../getting-started/data-dependency.md#subscriptions) |
45-
| [DevToolsManager](../api/DevToolsManager.md) | Enables [debugging](../guides/debugging.md) |
45+
| [DevToolsManager](../api/DevToolsManager.md) | Enables [debugging](../getting-started/debugging.md) |
4646
| Extra managers |
4747
| [LogoutManager](../api/LogoutManager.md) | Handles HTTP `401` (or other logout conditions) |
4848

docs/core/concepts/normalization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -385,13 +385,13 @@ per update.
385385
## Store Inspection (debugging)
386386

387387
[DevTools browser extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd?hl=en)
388-
can be installed to inspect and [debug the store](../guides/debugging.md).
388+
can be installed to inspect and [debug the store](../getting-started/debugging.md).
389389

390390
![browser-devtools](/img/devtool-state.png 'Reactive Data Client devtools')
391391

392392
<center>
393393

394-
<Link className="button button--secondary" to="../guides/debugging">Data Client Debugging Guide »</Link>
394+
<Link className="button button--secondary" to="../getting-started/debugging">Data Client Debugging Guide »</Link>
395395

396396
</center>
397397

packages/endpoint/src/schemas/Entity.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export default abstract class Entity extends EntitySchema(EmptyBase) {
8989
9090
This is likely due to a malformed response.
9191
Try inspecting the network response or fetch() return value.
92-
Or use debugging tools: https://dataclient.io/docs/guides/debugging
92+
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
9393
Learn more about schemas: https://dataclient.io/docs/api/schema
9494
If this is a mistake, you can disable this check by setting static automaticValidation = 'silent'
9595

packages/endpoint/src/schemas/EntitySchema.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ export default function EntitySchema<TBase extends Constructor>(
240240
241241
This is likely due to a malformed response.
242242
Try inspecting the network response or fetch() return value.
243-
Or use debugging tools: https://dataclient.io/docs/guides/debugging
243+
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
244244
Learn more about primary keys: https://dataclient.io/rest/api/Entity#pk
245245
246246
Entity: ${this.key}

packages/endpoint/src/schemas/Invalidate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default class Invalidate<
6060
6161
This is likely due to a malformed response.
6262
Try inspecting the network response or fetch() return value.
63-
Or use debugging tools: https://dataclient.io/docs/guides/debugging
63+
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
6464
Learn more about schemas: https://dataclient.io/docs/api/schema
6565
6666
Invalidate(Entity): Invalidate(${this._entity.key})

packages/react/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ For the small price of 9kb gziped. &nbsp;&nbsp; [🏁Get started now](https://da
226226
- [x] 🛑 Automatic overfetching elimination
227227
- [x] ✨ Fast [optimistic updates](https://dataclient.io/rest/guides/optimistic-updates)
228228
- [x] 🧘 [Flexible](https://dataclient.io/docs/getting-started/resource) to fit any API design (one size fits all)
229-
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/guides/debugging) via browser extension
229+
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/getting-started/debugging) via browser extension
230230
- [x] 🌳 Tree-shakable (only use what you need)
231231
- [x] 🔁 [Subscriptions](https://dataclient.io/docs/api/useSubscription)
232232
- [x] ♻️ Optional [redux integration](https://dataclient.io/docs/guides/redux)

packages/react/src/components/DevToolsButton.tsx

+4-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ export default function DevToolsButton({
3333
<style>{`.rdc-devtool-btn {text-align:center;}.rdc-devtool-btn > div {visibility:hidden;text-align:center;}.rdc-devtool-btn:hover > div {visibility:visible;}.rdc-devtool-btn a {text-decoration:none;}`}</style>
3434
<div>
3535
DevTools{' '}
36-
<a href="https://dataclient.io/docs/guides/debugging" target="__blank">
36+
<a
37+
href="https://dataclient.io/docs/getting-started/debugging"
38+
target="__blank"
39+
>
3740
ℹ️
3841
</a>
3942
</div>

website/docusaurus.config.ts

+4
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,10 @@ const config: Config = {
342342
to: '/docs/api/ExternalDataProvider',
343343
from: ['/docs/api/ExternalCacheProvider'],
344344
},
345+
{
346+
to: '/docs/getting-started/debugging',
347+
from: ['/docs/guides/debugging'],
348+
},
345349
...gqlRedirects,
346350
],
347351
},

website/sidebars.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
},
2828
{
2929
"type": "doc",
30-
"id": "guides/debugging"
30+
"id": "getting-started/debugging"
3131
}
3232
]
3333
},

0 commit comments

Comments
 (0)