fix(nx-dev): correctly link to url fragments for devkit #32565
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
View your CI Pipeline Execution ↗ for commit 8379318
☁️ Nx Cloud last updated this comment at |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
21703e2 to
c1bd79b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
c1bd79b to
a9c5e14
Compare
a9c5e14 to
888fb08
Compare
a846760 to
8918e48
Compare
`@link` properties in typedoc were always assuming a top level /docs/reference/devkit/:link url. but they typically will link to a sub header of the same page. Now url generation check the parent to see if it's a devkit project fist to construct the URL. Fixes: DOC-63 wip: devkit url funs
I actually need to finish impl the reflection.type and reflection.typeParameters which would explain why some pages are missing some information
8918e48 to
f224c55
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
6106faf to
d66922b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
780d10a to
8a0c569
Compare
8a0c569 to
2996a10
Compare
There was a problem hiding this comment.
Nx Cloud is proposing a fix for your failed CI:
We fixed the formatting violations in devkit-generation.ts by removing trailing commas that were causing the nx format:check task to fail. These formatting issues were introduced during the recent devkit documentation system refactoring.
We verified this fix by re-running nx-cloud record -- nx format:check.
Suggested Fix changes
diff --git a/astro-docs/src/plugins/utils/devkit-generation.ts b/astro-docs/src/plugins/utils/devkit-generation.ts
index bb80c724f4..616106c19d 100644
--- a/astro-docs/src/plugins/utils/devkit-generation.ts
+++ b/astro-docs/src/plugins/utils/devkit-generation.ts
@@ -11,7 +11,7 @@ import { existsSync } from 'node:fs';
import { readFile, readdir } from 'node:fs/promises';
export async function loadDevkitPackage(
- context: LoaderContext,
+ context: LoaderContext
): Promise<CollectionEntry<'nx-reference-packages'>[]> {
const { logger, renderMarkdown } = context;
logger.info('Loading DevKit documentation');
@@ -30,7 +30,7 @@ export async function loadDevkitPackage(
'dist',
'packages',
'devkit',
- 'index.d.ts',
+ 'index.d.ts'
);
if (existsSync(devkitEntryPoint)) {
await runTypeDoc(
@@ -42,7 +42,7 @@ export async function loadDevkitPackage(
excludePrivate: true,
publicPath: '/docs/reference/devkit/',
},
- logger,
+ logger
);
}
@@ -53,7 +53,7 @@ export async function loadDevkitPackage(
'dist',
'packages',
'devkit',
- 'ngcli-adapter.d.ts',
+ 'ngcli-adapter.d.ts'
);
if (existsSync(ngcliEntryPoint)) {
await runTypeDoc(
@@ -64,7 +64,7 @@ export async function loadDevkitPackage(
out: join(outDir, 'ngcli_adapter'),
publicPath: '/docs/reference/devkit/ngcli_adapter/',
},
- logger,
+ logger
);
}
⚙️ An Nx Cloud workspace admin can disable these reviews in workspace settings.
2996a10 to
8379318
Compare
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
switch to making typedoc to the rendering and then pull in the generated file contents instead of manually parsing the reflection metadata.
Fixes: DOC-63