Skip to content

Commit 66722f5

Browse files
docs: correct local relative links (#282)
* docs: correct local relative links * Fix config imports
1 parent d655b6c commit 66722f5

File tree

22 files changed

+189
-239
lines changed

22 files changed

+189
-239
lines changed

docs/framework/react/basic-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,6 @@ createRoot(document.getElementById('root')!).render(
7474
)
7575
```
7676

77-
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../../configuration.md) section.
77+
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../configuration.md) section.
7878

7979
A complete working example can be found in our [basic example](https://tanstack.com/devtools/latest/docs/framework/react/examples/basic).

docs/framework/react/guides/custom-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export function DevtoolPanel() {
137137

138138
## Application Integration
139139

140-
This step follows what's shown in [basic-setup](../../basic-setup.md) for a more documented guide go check it out. As well as the complete [custom-devtools example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-devtools) in our examples section.
140+
This step follows what's shown in [basic-setup](../basic-setup.md) for a more documented guide go check it out. As well as the complete [custom-devtools example](https://tanstack.com/devtools/latest/docs/framework/react/examples/custom-devtools) in our examples section.
141141

142142
Main.tsx
143143
```tsx

docs/framework/solid/basic-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,6 @@ render(() => (
6868
), document.getElementById('root')!)
6969
```
7070

71-
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../../configuration.md) section.
71+
Finally add any additional configuration you desire to the `TanStackDevtools` component, more information can be found under the [TanStack Devtools Configuration](../../configuration.md) section.
7272

7373
A complete working example can be found in our [examples section](https://tanstack.com/devtools/latest/docs/framework/solid/examples).

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ npm install -D @tanstack/devtools-vite
4444
```
4545

4646

47-
Read more about using the devtools in production in our [Production docs](https://tanstack.com/devtools/latest/docs/production).
47+
Read more about using the devtools in production in our [Production docs](./production.md).

docs/reference/classes/tanstackdevtoolscore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Defined in: [devtools/src/core.tsx:53](https://github.com/TanStack/devtools/blob
2323

2424
##### init
2525

26-
[`TanStackDevtoolsInit`](../interfaces/tanstackdevtoolsinit.md)
26+
[`TanStackDevtoolsInit`](./interfaces/tanstackdevtoolsinit.md)
2727

2828
#### Returns
2929

@@ -67,7 +67,7 @@ Defined in: [devtools/src/core.tsx:94](https://github.com/TanStack/devtools/blob
6767

6868
##### config
6969

70-
`Partial`\<[`TanStackDevtoolsInit`](../interfaces/tanstackdevtoolsinit.md)\>
70+
`Partial`\<[`TanStackDevtoolsInit`](./interfaces/tanstackdevtoolsinit.md)\>
7171

7272
#### Returns
7373

eslint.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// @ts-check
22

33
// @ts-ignore Needed due to moduleResolution Node vs Bundler
4-
import { tanstackConfig } from '@tanstack/config/eslint'
4+
import { tanstackConfig } from '@tanstack/eslint-config'
55
import unusedImports from 'eslint-plugin-unused-imports'
66

77
export default [

nx.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@
4949
"inputs": ["production", "^production"],
5050
"outputs": ["{projectRoot}/build", "{projectRoot}/dist"]
5151
},
52+
"test:docs": {
53+
"cache": true,
54+
"inputs": ["{workspaceRoot}/docs/**/*"]
55+
},
5256
"test:knip": {
5357
"cache": true,
5458
"inputs": ["{workspaceRoot}/**/*"]

package.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
"clean:node_modules": "find . -name 'node_modules' -type d -prune -exec rm -rf {} +",
1919
"clean:all": "pnpm run clean && pnpm run clean:node_modules",
2020
"dev": "pnpm run watch",
21-
"docs:generate": "node scripts/generateDocs.ts",
2221
"format": "pnpm run prettier:write",
22+
"generate-docs": "node scripts/generate-docs.ts",
2323
"lint:fix": "nx affected --target=lint:fix --exclude=examples/**",
2424
"lint:fix:all": "pnpm run format && nx run-many --targets=lint --fix",
2525
"preinstall": "node -e \"if(process.env.CI == 'true') {console.log('Skipping preinstall...'); process.exit(1)}\" || npx -y only-allow pnpm",
@@ -29,6 +29,7 @@
2929
"test": "pnpm run test:ci",
3030
"test:build": "nx affected --target=test:build --exclude=examples/**",
3131
"test:ci": "nx run-many --targets=test:format,test:eslint,test:sherif,test:knip,test:lib,test:types,test:build,build",
32+
"test:docs": "node scripts/verify-links.ts",
3233
"test:eslint": "nx affected --target=test:eslint --exclude=examples/**",
3334
"test:format": "pnpm run prettier --check",
3435
"test:knip": "knip",
@@ -41,6 +42,7 @@
4142
},
4243
"nx": {
4344
"includedScripts": [
45+
"test:docs",
4446
"test:knip",
4547
"test:sherif"
4648
]
@@ -60,13 +62,16 @@
6062
"@faker-js/faker": "^9.9.0",
6163
"@size-limit/preset-small-lib": "^11.2.0",
6264
"@svitejs/changesets-changelog-github-compact": "^1.2.0",
63-
"@tanstack/config": "0.20.2",
65+
"@tanstack/eslint-config": "0.3.2",
66+
"@tanstack/typedoc-config": "0.2.1",
67+
"@tanstack/vite-config": "0.2.1",
6468
"@testing-library/jest-dom": "^6.8.0",
6569
"@types/node": "^22.15.2",
6670
"eslint": "^9.36.0",
6771
"eslint-plugin-unused-imports": "^4.2.0",
6872
"jsdom": "^27.0.0",
6973
"knip": "^5.64.0",
74+
"markdown-link-extractor": "^4.0.2",
7075
"nx": "^21.5.3",
7176
"premove": "^4.0.0",
7277
"prettier": "^3.6.2",

packages/devtools-client/vite.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { defineConfig, mergeConfig } from 'vitest/config'
2-
import { tanstackViteConfig } from '@tanstack/config/vite'
2+
import { tanstackViteConfig } from '@tanstack/vite-config'
33
import packageJson from './package.json'
44

55
const config = defineConfig({

packages/devtools-ui/vite.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { defineConfig, mergeConfig } from 'vitest/config'
2-
import { tanstackViteConfig } from '@tanstack/config/vite'
2+
import { tanstackViteConfig } from '@tanstack/vite-config'
33
import solid from 'vite-plugin-solid'
44
import packageJson from './package.json'
55
import type { Plugin } from 'vite'

0 commit comments

Comments
 (0)