Skip to content

Commit b88cbe7

Browse files
charpeniwan9chi
andauthored
docs: fix broken anchor links and add migrate-rules to sidebar (#2203)
## Summary Fixes four broken internal anchor links in the docs site and adds the previously-orphaned Migration Rules page to the guide sidebar. These surfaced during a proofreading pass over the documentation website. ## Changes **Broken anchors** — these links resolved to the correct page but silently failed to scroll to the target heading, because the anchor slugs didn't match VitePress's heading slugification (which collapses `.` and other special characters to `-`): - `guide/github-actions-cache.md` (2 links): `/config/run#tasks` → `/config/run#run-tasks` (heading is `## run.tasks`) - `guide/installer-env-vars.md`: `/guide/env#custom-nodejs-mirror` → `#custom-node-js-mirror` - `guide/installer-env-vars.md`: `/guide/env#nodejs-signature-verification` → `#node-js-signature-verification` **Navigation:** - Added "Migration Rules" (`/guide/migrate-rules`) to the guide sidebar, nested under "Migrate to Vite+" (matching the existing Check → Lint/Format nesting). The page previously existed and was reachable only through an inline link in `migrate.md`, with no sidebar entry. Co-authored-by: Charles Wang <3612422+wan9chi@users.noreply.github.com>
1 parent ae97a85 commit b88cbe7

3 files changed

Lines changed: 9 additions & 5 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ const guideSidebar = [
3232
items: [
3333
{ text: 'Getting Started', link: '/guide/' },
3434
{ text: 'Creating a Project', link: '/guide/create' },
35-
{ text: 'Migrate to Vite+', link: '/guide/migrate' },
35+
{
36+
text: 'Migrate to Vite+',
37+
link: '/guide/migrate',
38+
items: [{ text: 'Migration Rules', link: '/guide/migrate-rules' }],
39+
},
3640
{ text: 'Installing Dependencies', link: '/guide/install' },
3741
{ text: 'Environment', link: '/guide/env' },
3842
{ text: 'Installer Environment Variables', link: '/guide/installer-env-vars' },

docs/guide/github-actions-cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export default defineConfig({
4848
});
4949
```
5050

51-
This guide assumes each task already hits locally. If a task misses, fix its tracking config in `vite.config.ts` before adding the GitHub Actions cache steps. See [Automatic Data Tracking](/guide/automatic-data-tracking) and [`run.tasks`](/config/run#tasks).
51+
This guide assumes each task already hits locally. If a task misses, fix its tracking config in `vite.config.ts` before adding the GitHub Actions cache steps. See [Automatic Data Tracking](/guide/automatic-data-tracking) and [`run.tasks`](/config/run#run-tasks).
5252

5353
Run each task twice:
5454

@@ -129,7 +129,7 @@ If GitHub restores a cache but Vite Task prints a cache miss, the workflow resto
129129

130130
## Keep Task Tracking Stable
131131

132-
If GitHub restores a cache but `vp run` prints a cache miss, fix the task fingerprint before changing the Actions cache key. See [Automatic Data Tracking](/guide/automatic-data-tracking) and [`run.tasks`](/config/run#tasks).
132+
If GitHub restores a cache but `vp run` prints a cache miss, fix the task fingerprint before changing the Actions cache key. See [Automatic Data Tracking](/guide/automatic-data-tracking) and [`run.tasks`](/config/run#run-tasks).
133133

134134
## Choose A Cache Key
135135

docs/guide/installer-env-vars.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ These variables configure the installed Vite+ CLI. `VP_HOME` (above) also applie
8181

8282
- **Purpose**: Node.js distribution mirror URL
8383
- **Default**: `https://nodejs.org/dist`
84-
- **Details**: [Custom Node.js Mirror](/guide/env#custom-nodejs-mirror)
84+
- **Details**: [Custom Node.js Mirror](/guide/env#custom-node-js-mirror)
8585

8686
### `VP_NODE_VERSION`
8787

@@ -98,7 +98,7 @@ These variables configure the installed Vite+ CLI. `VP_HOME` (above) also applie
9898
- **Purpose**: Skip PGP signature verification of Node.js downloads
9999
- **Values**: Any non-empty value
100100
- **Default**: None (verification enabled)
101-
- **Details**: [Node.js Signature Verification](/guide/env#nodejs-signature-verification)
101+
- **Details**: [Node.js Signature Verification](/guide/env#node-js-signature-verification)
102102

103103
### `VP_SHELL`
104104

0 commit comments

Comments
 (0)