fix(dgeni): correctly prefix API doc link paths (#2956)

graycoreio · Aug 8, 2024 · 9e95dd3 · 9e95dd3
1 parent db026e9
commit 9e95dd3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/tools/dgeni/src/transforms/daffodil-api-package/index.ts b/tools/dgeni/src/transforms/daffodil-api-package/index.ts
@@ -1,5 +1,10 @@
 import { Package } from 'dgeni';
 
+import {
+  DAFF_DOC_KIND_PATH_SEGMENT_MAP,
+  DaffDocKind,
+} from '@daffodil/docs-utils';
+
 import { DAFF_DGENI_EXCLUDED_PACKAGES_REGEX } from '../../constants/excluded-packages';
 import { AddInheritedDocsContentProcessor } from '../../processors/addInheritedDocsContent';
 import { AddLinkTagToDaffodilReferencesProcessor } from '../../processors/addLinkTagToDaffodilReferences';
@@ -19,7 +24,7 @@ import { daffodilBasePackage } from '../daffodil-base-package';
 const linksPackage = require('dgeni-packages/links');
 const typescriptPackage = require('dgeni-packages/typescript');
 
-export const apiDocs =  new Package('checkout', [
+export const apiDocs = new Package('daffodil-api', [
   daffodilBasePackage,
   typescriptPackage,
   linksPackage,
@@ -56,7 +61,7 @@ export const apiDocs =  new Package('checkout', [
   })
   .config((computePathsProcessor, EXPORT_DOC_TYPES, generateApiList) => {
 
-    const API_SEGMENT = 'api';
+    const API_SEGMENT = DAFF_DOC_KIND_PATH_SEGMENT_MAP[DaffDocKind.API];
 
     generateApiList.outputFolder = API_SEGMENT;
 
@@ -70,7 +75,7 @@ export const apiDocs =  new Package('checkout', [
     });
     computePathsProcessor.pathTemplates.push({
       docTypes: EXPORT_DOC_TYPES,
-      pathTemplate: '${moduleDoc.moduleFolder}/${name}',
+      pathTemplate: 'docs/${moduleDoc.moduleFolder}/${name}',
       outputPathTemplate: '${moduleDoc.moduleFolder}/${safeName}.json',
     });
   })

diff --git a/tools/dgeni/src/transforms/daffodil-base-package/index.ts b/tools/dgeni/src/transforms/daffodil-base-package/index.ts
@@ -33,6 +33,8 @@ export const daffodilBasePackage = new Package('daffodil-base', [
 
 // Where do we write the output files?
   .config((writeFilesProcessor) => {
+    // TODO: consider changing this to the parent so that the doc paths automatically include `docs/`
+    // we would avoid having to do things like https://github.com/graycoreio/daffodil/blob/db026e91c2e46b6ac895da86003f2f612800d917/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts#L15
     writeFilesProcessor.outputFolder = DOCS_OUTPUT_PATH;
   })