docs: guides/debugging -> getting-started/debugging

ntucker · ntucker · commit 0adad9209265 · 2024-07-22T12:05:48.000+02:00
diff --git a/.changeset/real-ties-trade.md b/.changeset/real-ties-trade.md
@@ -0,0 +1,8 @@
+---
+'@data-client/endpoint': patch
+'@data-client/react': patch
+'@data-client/graphql': patch
+'@data-client/rest': patch
+---
+
+Update debugging link
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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
 
diff --git a/README.md b/README.md
@@ -229,7 +229,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)
diff --git a/docs/core/README.md b/docs/core/README.md
@@ -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
diff --git a/docs/core/api/DevToolsManager.md b/docs/core/api/DevToolsManager.md
@@ -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).
diff --git a/docs/core/concepts/managers.md b/docs/core/concepts/managers.md
@@ -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"
@@ -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)                                      |
 
diff --git a/docs/core/concepts/normalization.md b/docs/core/concepts/normalization.md
@@ -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>
 
diff --git a/docs/core/getting-started/debugging.md b/docs/core/getting-started/debugging.md
diff --git a/packages/endpoint/src/schemas/Entity.ts b/packages/endpoint/src/schemas/Entity.ts
@@ -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'
 
diff --git a/packages/endpoint/src/schemas/EntitySchema.ts b/packages/endpoint/src/schemas/EntitySchema.ts
@@ -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}
diff --git a/packages/endpoint/src/schemas/Invalidate.ts b/packages/endpoint/src/schemas/Invalidate.ts
@@ -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})
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap
@@ -506,7 +506,7 @@ exports[`Entity normalization should throw a custom error if data does not inclu
 
   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: MyEntity
@@ -521,7 +521,7 @@ exports[`Entity normalization should throw a custom error if data does not inclu
 
   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: MyEntity
@@ -536,7 +536,7 @@ exports[`Entity normalization should throw a custom error if data loads with no
 
   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: MyEntity
@@ -561,7 +561,7 @@ exports[`Entity normalization should throw a custom error loads with array 1`] =
 
 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'
 
@@ -588,7 +588,7 @@ exports[`Entity normalization should warn when automaticValidation === "warn" 1`
 
 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'
 
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/EntitySchema.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/EntitySchema.test.ts.snap
@@ -494,7 +494,7 @@ exports[`EntitySchema normalization should error if no matching keys are found 1
 
   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: MyEntity
@@ -533,7 +533,7 @@ exports[`EntitySchema normalization should throw a custom error if data does not
 
   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: MyData
@@ -548,7 +548,7 @@ exports[`EntitySchema normalization should throw a custom error if data loads wi
 
   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: MyData
@@ -573,7 +573,7 @@ exports[`EntitySchema normalization should throw a custom error loads with array
 
   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: MyData
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Invalidate.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Invalidate.test.ts.snap
@@ -151,7 +151,7 @@ exports[`Invalidate normalization should throw a custom error if data does not i
 
   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(MyEntity)
@@ -166,7 +166,7 @@ exports[`Invalidate normalization should throw a custom error if data does not i
 
   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(MyEntity)
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -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)
diff --git a/packages/react/src/__tests__/__snapshots__/integration-endpoint.web.tsx.snap b/packages/react/src/__tests__/__snapshots__/integration-endpoint.web.tsx.snap
@@ -210,7 +210,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -429,7 +429,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
diff --git a/packages/react/src/components/DevToolsButton.tsx b/packages/react/src/components/DevToolsButton.tsx
@@ -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>
diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap
@@ -18,7 +18,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -43,7 +43,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -68,7 +68,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -93,7 +93,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap
@@ -18,7 +18,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -43,7 +43,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -68,7 +68,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
@@ -93,7 +93,7 @@ Attempted to initialize CoolerArticle with an array, but named members were expe
 
 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'
 
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -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,
         ],
       },
diff --git a/website/sidebars.json b/website/sidebars.json
@@ -27,7 +27,7 @@
         },
         {
           "type": "doc",
-          "id": "guides/debugging"
+          "id": "getting-started/debugging"
         }
       ]
     },

Original file line number	Diff line number	Diff line change
`@@ -95,4 +95,4 @@ ReactDOM.createRoot(document.body).render(`
`95`	`95`
`96`	`96`	`## More info`
`97`	`97`
`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).`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`},`
`28`	`28`	`{`
`29`	`29`	`"type": "doc",`
`30`		`- "id": "guides/debugging"`
	`30`	`+ "id": "getting-started/debugging"`
`31`	`31`	`}`
`32`	`32`	`]`
`33`	`33`	`},`