feat: add support for agentic plugin documentation

Author: Ed-Marcavage

scripts/jsdoc-automation/src/AIService.ts

@@ -64,13 +64,11 @@ export class AIService {
     public async generatePluginDocumentation({
         existingDocs,
         packageJson,
-        readmeContent,
         todoItems,
         envUsages
     }: {
         existingDocs: ASTQueueItem[];
         packageJson: any;
-        readmeContent?: string;
         todoItems: TodoItem[];
         envUsages: EnvUsage[];
     }): Promise<PluginDocumentation & { todos: string }> {
@@ -91,11 +89,6 @@ export class AIService {
         // Generate documentation for evaluators
         const evaluatorsDocumentation = await this.generateEvaluatorsDocumentation(exports.evaluators);
 
-
-        // write organizedDocs into a json in /here directory
-        const jsonPath = path.join(this.configuration.absolutePath, 'here', 'organizedDocs.json');
-        fs.writeFile(jsonPath, JSON.stringify(organizedDocs, null, 2));
-
         const [overview, installation, configuration, usage, apiRef, troubleshooting, todoSection] = await Promise.all([
             this.generateOverview(organizedDocs, packageJson),
             this.generateInstallation(packageJson),

scripts/jsdoc-automation/src/PluginDocumentationGenerator.ts

@@ -34,34 +34,34 @@ export class PluginDocumentationGenerator {
         if (!packageJson) {
             console.error('package.json not found');
         }
-
-        // Read existing README if it exists
-        const readmePath = path.join(this.configuration.absolutePath, 'README-automated.md');
-        const readmeContent = fs.existsSync(readmePath)
-            ? fs.readFileSync(readmePath, 'utf-8')
-            : undefined;
-
         // Generate documentation
         const documentation = await this.aiService.generatePluginDocumentation({
             existingDocs,
             packageJson,
-            readmeContent,
             todoItems,
             envUsages
         });
 
-        // Generate and write markdown
+        // Generate markdown content
         const markdownContent = this.generateMarkdownContent(documentation, packageJson);
-        fs.writeFileSync(readmePath, markdownContent);
 
-        // Commit if we're in a branch
+        // Only commit the file if we're in a branch
         if (branchName) {
+            // Use the configuration's relative path to determine the correct README location
+            const relativeReadmePath = path.join(
+                this.configuration.relativePath,
+                'README-automated.md'
+            );
+
+            // Commit the file to the correct location
             await this.gitManager.commitFile(
                 branchName,
-                'README.md',
+                relativeReadmePath,
                 markdownContent,
                 'docs: Update plugin documentation'
             );
+        } else {
+            console.error('No branch name provided, skipping commit for README-automated.md');
         }
     }