Some files in the ai/ directory (like ai/mcp/server/github-workflow/services/queries/issueQueries.mjs) are valid modules but are not intended to be displayed in the public Docs app. While we have implemented filtering for ai.examples and empty folders, we need a more declarative way to exclude specific files or classes from the Docs app navigation tree.
Goal
Implement support for a custom JSDoc tag @ignoreDocs. When this tag is present in a file's top-level comment block, jsdocx.mjs should skip generating a structure entry for it.
Implementation Details
Update buildScripts/docs/jsdocx.mjs:
- In the parsing loop, check if the
docs object (the JSDoc output for a file) contains the @ignoreDocs tag.
- If the tag is found, skip adding the item to the
neoStructure array (or filtering it out).
- Ensure this check happens before or during the structure generation phase.
Usage:
- Add
* @ignoreDocs to the top-level JSDoc comment of ai/mcp/server/github-workflow/services/queries/issueQueries.mjs and potentially other query modules.
Verification
- Add the tag to
issueQueries.mjs.
- Run
npm run generate-docs-json.
- Verify
issueQueries is no longer in docs/output/structure.json.
Some files in the
ai/directory (likeai/mcp/server/github-workflow/services/queries/issueQueries.mjs) are valid modules but are not intended to be displayed in the public Docs app. While we have implemented filtering forai.examplesand empty folders, we need a more declarative way to exclude specific files or classes from the Docs app navigation tree.Goal
Implement support for a custom JSDoc tag
@ignoreDocs. When this tag is present in a file's top-level comment block,jsdocx.mjsshould skip generating a structure entry for it.Implementation Details
Update
buildScripts/docs/jsdocx.mjs:docsobject (the JSDoc output for a file) contains the@ignoreDocstag.neoStructurearray (or filtering it out).Usage:
* @ignoreDocsto the top-level JSDoc comment ofai/mcp/server/github-workflow/services/queries/issueQueries.mjsand potentially other query modules.Verification
issueQueries.mjs.npm run generate-docs-json.issueQueriesis no longer indocs/output/structure.json.