The current docs/output/structure.json file is too large and inefficient for AI agent consumption. To provide a lean but effective overview of the project's class structure, we will create a new build artifact.
Goal
Modify the buildScripts/docs/jsdocx.mjs script to generate a new file at docs/output/class-hierarchy.yaml.
Requirements:
- Format: The file must be in YAML.
- Content: It will contain a simple key-value mapping of
className: parentClassName.
- Sorting: The entries must be sorted alphabetically by the
className (the key).
- Implementation: This will be done within the existing
jsdocx.mjs script, leveraging the already-parsed documentation data.
- Agent Integration: Update
AGENTS.md to instruct the agent to parse docs/output/class-hierarchy.yaml instead of the old structure.json file.
The current
docs/output/structure.jsonfile is too large and inefficient for AI agent consumption. To provide a lean but effective overview of the project's class structure, we will create a new build artifact.Goal
Modify the
buildScripts/docs/jsdocx.mjsscript to generate a new file atdocs/output/class-hierarchy.yaml.Requirements:
className: parentClassName.className(the key).jsdocx.mjsscript, leveraging the already-parsed documentation data.AGENTS.mdto instruct the agent to parsedocs/output/class-hierarchy.yamlinstead of the oldstructure.jsonfile.