Skip to content

Commit

Permalink
docs: guides/debugging -> getting-started/debugging
Browse files Browse the repository at this point in the history
  • Loading branch information
ntucker committed Jul 22, 2024
1 parent 2d9911c commit 0c826c2
Show file tree
Hide file tree
Showing 16 changed files with 30 additions and 15 deletions.
8 changes: 8 additions & 0 deletions .changeset/real-ties-trade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@data-client/endpoint': patch
'@data-client/react': patch
'@data-client/graphql': patch
'@data-client/rest': patch
---

Update debugging link
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A clear and concise description of what you expected to happen.
Include anything that could be related:
- Console errors and warnings
- [Network inspector](https://developer.chrome.com/docs/devtools/network/) screenshots
- [Browser Devtools](https://dataclient.io/docs/guides/debugging) screenshots or state and action dumps
- [Browser Devtools](https://dataclient.io/docs/getting-started/debugging) screenshots or state and action dumps

**Minimum reproducable example or test case**
For many cases reproducing the bug is fairly straightforward. However, if
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
why you expected it.
* Include any relevant stack traces or debugging output.
* Ensure you captured relevant [network inspector](https://developer.chrome.com/docs/devtools/network/) screenshots
* Ensure [Browser Devtools](https://dataclient.io/docs/guides/debugging) screenshots or state and action dumps
* Ensure [Browser Devtools](https://dataclient.io/docs/getting-started/debugging) screenshots or state and action dumps

## Feature Requests

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ For the small price of 9kb gziped.    [🏁Get started now](https://da
- [x] 🛑 Automatic overfetching elimination
- [x] ✨ Fast [optimistic updates](https://dataclient.io/rest/guides/optimistic-updates)
- [x] 🧘 [Flexible](https://dataclient.io/docs/getting-started/resource) to fit any API design (one size fits all)
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/guides/debugging) via browser extension
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/getting-started/debugging) via browser extension
- [x] 🌳 Tree-shakable (only use what you need)
- [x] 🔁 [Subscriptions](https://dataclient.io/docs/api/useSubscription)
- [x] ♻️ Optional [redux integration](https://dataclient.io/docs/guides/redux)
Expand Down
2 changes: 1 addition & 1 deletion docs/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ Add the Redux DevTools for
or
[firefox extension](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/)

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

## Mock data
Expand Down
2 changes: 1 addition & 1 deletion docs/core/api/DevToolsManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ ReactDOM.createRoot(document.body).render(

## More info

Using this Manager allows in browser [debugging and store inspection](../guides/debugging).
Using this Manager allows in browser [debugging and store inspection](../getting-started/debugging.md).
4 changes: 2 additions & 2 deletions docs/core/concepts/managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import StackBlitz from '@site/src/components/StackBlitz';
# Managers and Middleware

Reactive Data Client uses the [flux store](https://facebookarchive.github.io/flux/docs/in-depth-overview/) pattern, which is
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).
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).

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

Expand Down
4 changes: 2 additions & 2 deletions docs/core/concepts/normalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,13 +385,13 @@ per update.
## Store Inspection (debugging)

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

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

<center>

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

</center>

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion packages/endpoint/src/schemas/Entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export default abstract class Entity extends EntitySchema(EmptyBase) {
This is likely due to a malformed response.
Try inspecting the network response or fetch() return value.
Or use debugging tools: https://dataclient.io/docs/guides/debugging
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
Learn more about schemas: https://dataclient.io/docs/api/schema
If this is a mistake, you can disable this check by setting static automaticValidation = 'silent'
Expand Down
2 changes: 1 addition & 1 deletion packages/endpoint/src/schemas/EntitySchema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ export default function EntitySchema<TBase extends Constructor>(
This is likely due to a malformed response.
Try inspecting the network response or fetch() return value.
Or use debugging tools: https://dataclient.io/docs/guides/debugging
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
Learn more about primary keys: https://dataclient.io/rest/api/Entity#pk
Entity: ${this.key}
Expand Down
2 changes: 1 addition & 1 deletion packages/endpoint/src/schemas/Invalidate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default class Invalidate<
This is likely due to a malformed response.
Try inspecting the network response or fetch() return value.
Or use debugging tools: https://dataclient.io/docs/guides/debugging
Or use debugging tools: https://dataclient.io/docs/getting-started/debugging
Learn more about schemas: https://dataclient.io/docs/api/schema
Invalidate(Entity): Invalidate(${this._entity.key})
Expand Down
2 changes: 1 addition & 1 deletion packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ For the small price of 9kb gziped. &nbsp;&nbsp; [🏁Get started now](https://da
- [x] 🛑 Automatic overfetching elimination
- [x] ✨ Fast [optimistic updates](https://dataclient.io/rest/guides/optimistic-updates)
- [x] 🧘 [Flexible](https://dataclient.io/docs/getting-started/resource) to fit any API design (one size fits all)
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/guides/debugging) via browser extension
- [x] 🔧 [Debugging and inspection](https://dataclient.io/docs/getting-started/debugging) via browser extension
- [x] 🌳 Tree-shakable (only use what you need)
- [x] 🔁 [Subscriptions](https://dataclient.io/docs/api/useSubscription)
- [x] ♻️ Optional [redux integration](https://dataclient.io/docs/guides/redux)
Expand Down
5 changes: 4 additions & 1 deletion packages/react/src/components/DevToolsButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ export default function DevToolsButton({
<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>
<div>
DevTools{' '}
<a href="https://dataclient.io/docs/guides/debugging" target="__blank">
<a
href="https://dataclient.io/docs/getting-started/debugging"
target="__blank"
>
ℹ️
</a>
</div>
Expand Down
4 changes: 4 additions & 0 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,10 @@ const config: Config = {
to: '/docs/api/ExternalDataProvider',
from: ['/docs/api/ExternalCacheProvider'],
},
{
to: '/docs/getting-started/debugging',
from: ['/docs/guides/debugging'],
},
...gqlRedirects,
],
},
Expand Down
2 changes: 1 addition & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
},
{
"type": "doc",
"id": "guides/debugging"
"id": "getting-started/debugging"
}
]
},
Expand Down

0 comments on commit 0c826c2

Please sign in to comment.