Skip to content

Commit bd9fc5a

Browse files
committed
Updates from reviewing PR
1 parent ec85c23 commit bd9fc5a

File tree

2 files changed

+7
-50
lines changed

2 files changed

+7
-50
lines changed

.github/workflows/update_references.yml

Lines changed: 0 additions & 50 deletions
This file was deleted.

tasks/clean-references.mjs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@ import { writeFileSync, readFileSync } from 'fs';
22
import { packageCategories } from '../src/data/api-categories.mjs';
33
import { processReferences } from '../src/data/process-typedoc.mjs';
44

5+
/**
6+
* The purpose of this script is to create generate an object that only contains
7+
* the desired category nodes and every node needed to generate the api documentation
8+
* for these nodes. This is done by iterating over the needed category nodes and
9+
* then recursively adding every node found into cleanReferences.
10+
*/
11+
512
/**
613
* Read the -p flag from the cli params
714
*

0 commit comments

Comments
 (0)