docs(nxdev): take into account custom description (#13987)

nrwl · Dec 22, 2022 · c69e99f · c69e99f · vercel · Dec 22, 2022
1 parent 66ad046
commit c69e99f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/nx-dev/models-package/src/lib/package.models.ts b/nx-dev/models-package/src/lib/package.models.ts
@@ -24,13 +24,14 @@ export interface FileMetadata {
 export interface PackageData {
   description: string;
   documents: {
-    tags: string[];
-    id: string;
-    name: string;
-    itemList: any[];
     content: string;
+    description: string;
     file: string;
+    id: string;
+    itemList: any[];
+    name: string;
     path: string;
+    tags: string[];
   }[];
   executors: SchemaMetadata[];
   generators: SchemaMetadata[];

diff --git a/scripts/documentation/package-schemas/generatePackageSchemas.ts b/scripts/documentation/package-schemas/generatePackageSchemas.ts
@@ -66,7 +66,7 @@ export function generatePackageSchemas(): Promise<void[]> {
       description: p.description,
       documents: p.documents.map((d) => ({
         ...createDocumentMetadata({
-          description: p.description,
+          description: d.description || p.description,
           file: ['generated', 'packages', p.name, 'documents', d.id].join('/'),
           id: d.id,
           itemList: d.itemList,