Skip to content

Commit 809e48f

Browse files
update
1 parent d289615 commit 809e48f

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

.github/workflows/ci-link-validator.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ jobs:
2121

2222
- name: Run Link Check
2323
run: pnpm ci:build
24+
# Link validation errors will cause the build to fail automatically

astro.config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ const linkValidator = process.env.CHECK_LINKS
1919
starlightLinksValidator({
2020
errorOnFallbackPages: false,
2121
errorOnInconsistentLocale: true,
22+
// Exclude TypeDoc paths as they contain auto-generated content with many internal links
2223
exclude: ['/*/typedoc/**/*'],
2324
}),
2425
]

typedoc.config.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,11 @@ const tdMDX = createStarlightTypeDocPlugin()[0];
5757
// Set to true to enable testing mode for TypeDoc
5858
const testTypeDoc = false;
5959

60+
// When CHECK_LINKS is set, we disable TypeDoc plugins (isProd becomes false)
61+
// to improve performance and prevent link validation errors in generated docs
6062
const isLinkCheck = !!process.env.CHECK_LINKS;
6163

62-
const isProd = isLinkCheck === false && process.env.NODE_ENV === 'production';
64+
const isProd = !isLinkCheck && process.env.NODE_ENV === 'production';
6365

6466
const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[] => {
6567
if (isProd || testingMode) {

0 commit comments

Comments
 (0)