@aigne/doc-smith 0.8.12-beta.7 → 0.8.12-beta.9

package/utils/upload-files.mjs

@@ -0,0 +1,231 @@
+import crypto from "node:crypto";
+import fs from "node:fs";
+import path from "node:path";
+
+import pLimit from "p-limit";
+import pRetry from "p-retry";
+
+import { getComponentMountPoint } from "./blocklet.mjs";
+import { DISCUSS_KIT_DID } from "./constants/index.mjs";
+import { getMimeType } from "./file-utils.mjs";
+
+/**
+ * Perform single file upload
+ */
+async function performSingleUpload(filePath, fileHash, uploadEndpoint, accessToken, url) {
+  const baseFilename = path.basename(filePath, path.extname(filePath));
+  const fileBuffer = fs.readFileSync(filePath);
+  const stats = fs.statSync(filePath);
+  const fileSize = stats.size;
+  const fileExt = path.extname(filePath).substring(1);
+  const mimeType = getMimeType(filePath);
+
+  const hashBasedFilename = `${fileHash.substring(0, 16)}.${fileExt}`;
+
+  const uploaderId = "Uploader";
+  const fileId = `${uploaderId}-${baseFilename.toLowerCase().replace(/[^a-z0-9]/g, "")}-${fileHash.substring(0, 16)}`;
+
+  const tusMetadata = {
+    uploaderId,
+    relativePath: hashBasedFilename,
+    name: hashBasedFilename,
+    type: mimeType,
+    filetype: mimeType,
+    filename: hashBasedFilename,
+  };
+
+  const encodedMetadata = Object.entries(tusMetadata)
+    .map(([key, value]) => `${key} ${Buffer.from(value).toString("base64")}`)
+    .join(",");
+
+  const uploadEndpointUrl = new URL(uploadEndpoint);
+  const endpointPath = uploadEndpointUrl.pathname;
+
+  // Create upload
+  const createResponse = await fetch(uploadEndpoint, {
+    method: "POST",
+    headers: {
+      "Tus-Resumable": "1.0.0",
+      "Upload-Length": fileSize.toString(),
+      "Upload-Metadata": encodedMetadata,
+      Cookie: `login_token=${accessToken}`,
+      "x-uploader-file-name": hashBasedFilename,
+      "x-uploader-file-id": fileId,
+      "x-uploader-file-ext": fileExt,
+      "x-uploader-base-url": endpointPath,
+      "x-uploader-endpoint-url": uploadEndpoint,
+      "x-uploader-metadata": JSON.stringify({
+        uploaderId,
+        relativePath: hashBasedFilename,
+        name: hashBasedFilename,
+        type: mimeType,
+      }),
+      "x-component-did": DISCUSS_KIT_DID,
+    },
+  });
+
+  if (!createResponse.ok) {
+    const errorText = await createResponse.text();
+    throw new Error(
+      `Failed to create upload: ${createResponse.status} ${createResponse.statusText}\n${errorText}`,
+    );
+  }
+
+  const uploadUrl = createResponse.headers.get("Location");
+  if (!uploadUrl) {
+    throw new Error("No upload URL received from server");
+  }
+
+  // Upload file content
+  const uploadResponse = await fetch(`${url.origin}${uploadUrl}`, {
+    method: "PATCH",
+    headers: {
+      "Tus-Resumable": "1.0.0",
+      "Upload-Offset": "0",
+      "Content-Type": "application/offset+octet-stream",
+      Cookie: `login_token=${accessToken}`,
+      "x-uploader-file-name": hashBasedFilename,
+      "x-uploader-file-id": fileId,
+      "x-uploader-file-ext": fileExt,
+      "x-uploader-base-url": endpointPath,
+      "x-uploader-endpoint-url": uploadEndpoint,
+      "x-uploader-metadata": JSON.stringify({
+        uploaderId,
+        relativePath: hashBasedFilename,
+        name: hashBasedFilename,
+        type: mimeType,
+      }),
+      "x-component-did": DISCUSS_KIT_DID,
+      "x-uploader-file-exist": "true",
+    },
+    body: fileBuffer,
+  });
+
+  if (!uploadResponse.ok) {
+    const errorText = await uploadResponse.text();
+    throw new Error(
+      `Failed to upload file: ${uploadResponse.status} ${uploadResponse.statusText}\n${errorText}`,
+    );
+  }
+
+  const uploadResult = await uploadResponse.json();
+
+  let uploadedFileUrl = uploadResult.url;
+  if (!uploadedFileUrl && uploadResult?.size) {
+    uploadedFileUrl = uploadResponse.url;
+  }
+
+  if (!uploadedFileUrl) {
+    throw new Error("No URL found in the upload response");
+  }
+
+  return {
+    filePath,
+    url: uploadedFileUrl,
+  };
+}
+
+/**
+ * Upload multiple files with concurrency control
+ * @param {Object} options - Upload options
+ * @param {string} options.appUrl - Application URL
+ * @param {string[]} options.filePaths - Array of file paths to upload
+ * @param {string} options.accessToken - Access token for authentication
+ * @param {number} [options.concurrency=3] - Number of concurrent uploads
+ * @param {string} [options.endpoint] - Custom upload endpoint
+ * @returns {Promise<{results: Array<{filePath: string, url: string}>}>}
+ */
+export async function uploadFiles(options) {
+  const { appUrl, filePaths, endpoint, concurrency = 3, accessToken } = options;
+
+  if (filePaths.length === 0) {
+    return { results: [] };
+  }
+
+  const url = new URL(appUrl);
+  const mountPoint = await getComponentMountPoint(appUrl, DISCUSS_KIT_DID);
+
+  // Use custom endpoint or default to discuss kit media endpoint
+  const uploadEndpoint = endpoint || `${url.origin}${mountPoint}/api/uploads`;
+
+  const limit = pLimit(concurrency);
+  const ongoingUploads = new Map();
+
+  const uploadPromises = filePaths.map((filePath) =>
+    limit(async () => {
+      const filename = path.basename(filePath);
+
+      try {
+        const fileBuffer = fs.readFileSync(filePath);
+        const fileHash = crypto.createHash("sha256").update(fileBuffer).digest("hex");
+
+        // Check if this file is already being uploaded
+        const existingUpload = ongoingUploads.get(fileHash);
+        if (existingUpload) {
+          const result = await existingUpload;
+          return {
+            filePath,
+            url: result.url,
+          };
+        }
+
+        // Create upload promise and cache it
+        const uploadPromise = (async () => {
+          try {
+            const result = await pRetry(
+              () => performSingleUpload(filePath, fileHash, uploadEndpoint, accessToken, url),
+              {
+                retries: 3,
+                onFailedAttempt: (error) => {
+                  console.warn(
+                    `File upload attempt ${error.attemptNumber} failed for "${filename}". Remaining retries: ${error.retriesLeft}`,
+                  );
+                  if (error.retriesLeft === 0) {
+                    console.error(
+                      `File upload failed - all retry attempts exhausted for "${filename}"`,
+                    );
+                  }
+                },
+              },
+            );
+
+            return result;
+          } catch (error) {
+            console.error(
+              `File upload failed - error uploading "${filename}" after all retries:`,
+              error,
+            );
+            return {
+              filePath,
+              url: "",
+            };
+          }
+        })();
+
+        // Cache the upload promise
+        ongoingUploads.set(fileHash, uploadPromise);
+
+        try {
+          const result = await uploadPromise;
+          return {
+            filePath,
+            url: result.url,
+          };
+        } finally {
+          // Clean up the ongoing upload tracking
+          ongoingUploads.delete(fileHash);
+        }
+      } catch (error) {
+        console.error(`Error processing ${filename}:`, error);
+        return {
+          filePath,
+          url: "",
+        };
+      }
+    }),
+  );
+
+  const uploadResults = await Promise.all(uploadPromises);
+
+  return { results: uploadResults };
+}

package/utils/utils.mjs

@@ -47,6 +47,16 @@ export function isGlobPattern(pattern) {
   return /[*?[\]]|(\*\*)/.test(pattern);
 }
 
+/**
+ * Check if a string is an HTTP/HTTPS URL
+ * @param {string} url - The string to check
+ * @returns {boolean} - True if the string starts with http:// or https://
+ */
+export function isHttp(url) {
+  if (typeof url !== "string") return false;
+  return url.startsWith("http://") || url.startsWith("https://");
+}
+
 export function processContent({ content }) {
   // Match markdown regular links [text](link), exclude images ![text](link)
   return content.replace(/(?<!!)\[([^\]]+)\]\(([^)]+)\)/g, (match, text, link) => {
@@ -1112,7 +1122,7 @@ export async function resolveFileReferences(obj, basePath = process.cwd()) {
  * @param {string} basePath - Base path for resolving relative paths
  * @returns {Promise<any>} - The loaded content or original path if loading fails
  */
-async function loadFileContent(filePath, basePath) {
+export async function loadFileContent(filePath, basePath) {
   try {
     // Resolve path - if absolute, use as is; if relative, resolve from basePath
     const resolvedPath = path.isAbsolute(filePath) ? filePath : path.resolve(basePath, filePath);

package/.aigne/doc-smith/config.yaml

@@ -1,77 +0,0 @@
-# Project information for documentation publishing
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# Documentation Configuration
-# =============================================================================
-
-# Purpose: What's the main outcome you want readers to achieve?
-# Available options (uncomment and modify as needed):
-#   getStarted       - Get started quickly: Help new users go from zero to working in <30 minutes
-#   completeTasks    - Complete specific tasks: Guide users through common workflows and use cases
-#   findAnswers      - Find answers fast: Provide searchable reference for all features and APIs
-#   understandSystem - Understand the system: Explain how it works, why design decisions were made
-#   solveProblems    - Solve problems: Help users troubleshoot and fix issues
-#   mixedPurpose     - Mix of above: Comprehensive documentation covering multiple needs
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# Target Audience: Who will be reading this most often?
-# Available options (uncomment and modify as needed):
-#   endUsers         - End users (non-technical): People who use the product but don't code
-#   developers       - Developers integrating: Engineers adding this to their projects
-#   devops           - DevOps/Infrastructure: Teams deploying, monitoring, maintaining systems
-#   decisionMakers   - Technical decision makers: Architects, leads evaluating or planning implementation
-#   supportTeams     - Support teams: People helping others use the product
-#   mixedTechnical   - Mixed technical audience: Developers, DevOps, and technical users
-targetAudienceTypes:
-  - endUsers
-
-# Reader Knowledge Level: What do readers typically know when they arrive?
-# Available options (uncomment and modify as needed):
-#   completeBeginners    - Complete beginners: New to this domain/technology entirely
-#   domainFamiliar       - Domain-familiar, tool-new: Know the problem space, new to this specific solution
-#   experiencedUsers     - Experienced users: Regular users needing reference/advanced topics
-#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
-#   exploringEvaluating  - Exploring/evaluating: Trying to understand if this fits their needs
-readerKnowledgeLevel: completeBeginners
-
-# Documentation Depth: How comprehensive should the documentation be?
-# Available options (uncomment and modify as needed):
-#   essentialOnly      - Essential only: Cover the 80% use cases, keep it concise
-#   balancedCoverage   - Balanced coverage: Good depth with practical examples [RECOMMENDED]
-#   comprehensive      - Comprehensive: Cover all features, edge cases, and advanced scenarios
-#   aiDecide           - Let AI decide: Analyze code complexity and suggest appropriate depth
-documentationDepth: comprehensive
-
-# Custom Rules: Define specific documentation generation rules and requirements
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# Target Audience: Describe your specific target audience and their characteristics
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-lastGitHead: f0db74dffd0876dab4cc3ad628523abd359c9430
-# ⚠️ Warning: boardId is auto-generated by system, please do not edit manually
-boardId: "docsmith"
-appUrl: https://docsmith.aigne.io
-# Checkout ID for document deployment service
-checkoutId: ""

package/.aigne/doc-smith/history.yaml

@@ -1,37 +0,0 @@
-entries:
-  - timestamp: 2025-10-11T13:21:51.992Z
-    operation: translation_update
-    feedback: Do not translate the Target column in the Cleanup Targets table.
-    documentPath: /guides/cleaning-up
-  - timestamp: 2025-10-11T13:20:30.314Z
-    operation: document_update
-    feedback: The targets in Cleanup Targets are incomplete and need to be supplemented. The corresponding descriptions also require updating. Additionally, the target values should use the original enumeration values, such as 'generatedDocs'.
-    documentPath: /guides/cleaning-up
-  - timestamp: 2025-10-11T13:03:20.327Z
-    operation: document_update
-    feedback: The two aliases for the 'history' command in Viewing Update History can be combined into a single code block. The Short Hash in Understanding the History Output now consists of 8 characters. Additionally, operation types are separated by underscores, such as 'document_update'.
-    documentPath: /guides/managing-history
-  - timestamp: 2025-10-11T12:56:23.107Z
-    operation: document_update
-    feedback: In interactive mode, translated files are saved with a suffix appended to their original filenames within the same directory, rather than in dedicated language directories.
-    documentPath: /guides/translating-documentation
-  - timestamp: 2025-10-11T12:50:25.563Z
-    operation: document_update
-    feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/', and '.md' should be preserved.
-    documentPath: /guides/updating-documentation
-  - timestamp: 2025-10-11T12:46:37.507Z
-    operation: document_update
-    feedback: The value of the 'docs' parameter in the demo should be a path separated by '-' rather than '/'.
-    documentPath: /guides/updating-documentation
-  - timestamp: 2025-10-11T12:39:53.222Z
-    operation: document_update
-    feedback: The prompts in Review the Documentation Structure are outdated and need updating. Command Parameters also require updating.
-    documentPath: /guides/generating-documentation
-  - timestamp: 2025-10-11T12:26:24.598Z
-    operation: translation_update
-    feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
-    documentPath: /overview
-  - timestamp: 2025-10-11T12:24:05.477Z
-    operation: document_update
-    feedback: Add a link to the AIGNE Framework 'https://www.aigne.io/framework'.
-    documentPath: /overview

package/.aigne/doc-smith/output/structure-plan.json

@@ -1,162 +0,0 @@
-[
-  {
-    "title": "Overview",
-    "description": "Explains what AIGNE DocSmith does, the problems it solves, and its main capabilities based on your project's code.",
-    "path": "/overview",
-    "sourceIds": ["README.md", "aigne.yaml", ".aigne/doc-smith/config.yaml"],
-    "parentId": ""
-  },
-  {
-    "title": "Getting Started",
-    "description": "Provides a step-by-step guide to installing the tool and generating your first set of documents.",
-    "path": "/getting-started",
-    "sourceIds": ["README.md", "agents/init/index.mjs", "media.md"],
-    "parentId": ""
-  },
-  {
-    "title": "Guides",
-    "description": "Contains step-by-step instructions for performing common documentation tasks.",
-    "path": "/guides",
-    "sourceIds": [
-      "aigne.yaml",
-      "README.md",
-      "agents/generate/index.yaml",
-      "agents/update/index.yaml",
-      "agents/translate/index.yaml",
-      "agents/publish/index.yaml",
-      "agents/clear/index.yaml",
-      "agents/evaluate/index.yaml",
-      "agents/history/index.yaml",
-      "agents/chat/index.yaml"
-    ],
-    "parentId": ""
-  },
-  {
-    "title": "Configuration",
-    "description": "Details how to set up the tool and manage personal preferences for document generation.",
-    "path": "/configuration",
-    "sourceIds": [
-      "aigne.yaml",
-      "agents/init/index.mjs",
-      "agents/prefs/index.mjs",
-      ".aigne/doc-smith/config.yaml"
-    ],
-    "parentId": ""
-  },
-  {
-    "title": "Release Notes",
-    "description": "Lists new features, improvements, and bug fixes for each version of the tool.",
-    "path": "/release-notes",
-    "sourceIds": ["CHANGELOG.md"],
-    "parentId": ""
-  },
-  {
-    "title": "Generating Documentation",
-    "description": "Walks through the process of creating a new set of documents from your source files from start to finish.",
-    "path": "/guides/generating-documentation",
-    "sourceIds": [
-      "agents/generate/index.yaml",
-      "agents/generate/generate-structure.yaml",
-      "agents/generate/user-review-document-structure.mjs",
-      "agents/update/batch-generate-document.yaml",
-      "README.md",
-      "agents/generate/check-need-generate-structure.mjs",
-      "agents/generate/refine-document-structure.yaml",
-      "agents/generate/check-document-structure.yaml"
-    ],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Updating Documentation",
-    "description": "Explains how to modify existing documents based on code changes or new feedback.",
-    "path": "/guides/updating-documentation",
-    "sourceIds": [
-      "agents/update/index.yaml",
-      "agents/update/update-single-document.yaml",
-      "agents/update/batch-update-document.yaml",
-      "agents/update/user-review-document.mjs",
-      "README.md",
-      "agents/update/check-update-is-single.mjs",
-      "agents/update/handle-document-update.yaml",
-      "agents/update/generate-document.yaml"
-    ],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Translating Documentation",
-    "description": "Details the steps to translate your documents into multiple supported languages.",
-    "path": "/guides/translating-documentation",
-    "sourceIds": [
-      "agents/translate/index.yaml",
-      "agents/translate/translate-multilingual.yaml",
-      "agents/translate/choose-language.mjs",
-      "README.md",
-      "agents/translate/translate-document.yaml",
-      "agents/translate/record-translation-history.mjs"
-    ],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Publishing Your Docs",
-    "description": "Shows how to make your generated documentation live and accessible online.",
-    "path": "/guides/publishing-your-docs",
-    "sourceIds": ["agents/publish/index.yaml", "agents/publish/publish-docs.mjs", "README.md"],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Initial Setup",
-    "description": "Guides you through the interactive setup process to create your initial configuration file.",
-    "path": "/configuration/initial-setup",
-    "sourceIds": ["agents/init/index.mjs", "README.md", ".aigne/doc-smith/config.yaml"],
-    "parentId": "/configuration"
-  },
-  {
-    "title": "Managing Preferences",
-    "description": "Explains how to view, remove, and toggle your saved preferences for documentation generation.",
-    "path": "/configuration/managing-preferences",
-    "sourceIds": ["agents/prefs/index.mjs", "README.md"],
-    "parentId": "/configuration"
-  },
-  {
-    "title": "Managing History",
-    "description": "Shows how to view the history of updates made to your documentation.",
-    "path": "/guides/managing-history",
-    "sourceIds": ["agents/history/view.mjs", "aigne.yaml", "agents/history/index.yaml"],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Evaluating Documents",
-    "description": "Details how to use the evaluation command to assess the quality and completeness of your generated documentation.",
-    "path": "/guides/evaluating-documents",
-    "sourceIds": [
-      "agents/evaluate/index.yaml",
-      "aigne.yaml",
-      "agents/evaluate/document-structure.yaml",
-      "agents/evaluate/document.yaml",
-      "agents/evaluate/generate-report.mjs"
-    ],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Cleaning Up",
-    "description": "Provides instructions on how to use the clear command to remove generated files, configurations, and cached data.",
-    "path": "/guides/cleaning-up",
-    "sourceIds": [
-      "agents/clear/index.yaml",
-      "aigne.yaml",
-      "agents/clear/choose-contents.mjs",
-      "agents/clear/clear-generated-docs.mjs",
-      "agents/clear/clear-document-structure.mjs",
-      "agents/clear/clear-document-config.mjs",
-      "agents/clear/clear-auth-tokens.mjs"
-    ],
-    "parentId": "/guides"
-  },
-  {
-    "title": "Interactive Chat",
-    "description": "Explains how to use the interactive chat assistant to generate, modify, and manage your documentation.",
-    "path": "/guides/interactive-chat",
-    "sourceIds": ["agents/chat/index.yaml", "aigne.yaml"],
-    "parentId": "/guides"
-  }
-]

package/.aigne/doc-smith/preferences.yml

@@ -1,97 +0,0 @@
-rules:
-  - id: pref_cbc8005011c08ca0
-    active: true
-    scope: translation
-    rule: In the table titled 'Cleanup Targets', the 'Target' column must retain the original text and should not be translated.
-    feedback: Do not translate the Target column in the Cleanup Targets table.
-    createdAt: 2025-10-11T13:22:06.529Z
-  - id: pref_545cabc521ecd4a5
-    active: true
-    scope: translation
-    rule: The proprietary term 'AIGNE Framework' must not be translated and must be retained in its original form.
-    feedback: AIGNE Framework is a proper noun and has its own link; no translation is required.
-    createdAt: 2025-10-11T12:26:37.517Z
-  - id: pref_6e612d7ca8b7f3b6
-    active: true
-    scope: document
-    rule: When describing publishing options, should use plain text instead of custom components, and recommend users to run
-      their own Discuss Kit instance while providing relevant links.
-    feedback: "Publishing options should not use custom components: recommend users to run their own Discuss Kit instance in
-      the text, and add Discuss Kit related links"
-    createdAt: 2025-09-07T02:18:22.237Z
-  - id: pref_039b58c47bdf95c9
-    active: true
-    scope: document
-    rule: In the "Prerequisites" section, should briefly introduce Node.js installation, specify using npm instead of pnpm,
-      and guide users to the official website for detailed instructions.
-    feedback: In the prerequisites section, provide a simple introduction on how to install Node.js, no need to install pnpm
-      but use npm instead, guide users to the product official website for detailed installation instructions
-    createdAt: 2025-09-07T02:06:39.559Z
-  - id: pref_03a45a593f645ce2
-    active: true
-    scope: document
-    rule: When describing Discuss Kit, must clearly state that it is a non-open-source service running on the official
-      platform, not a self-hosted instance.
-    feedback: "In the core features description about document publishing, show the official platform link, run your own
-      Discuss Kit instance, not self-hosted: Discuss Kit is not open source."
-    createdAt: 2025-09-07T01:59:12.876Z
-  - id: pref_0c239f619329089f
-    active: true
-    scope: document
-    rule: In the core features section, should use plain list format and add descriptions and links for AIGNE Hub and
-      Discuss Kit.
-    feedback: Core features section should not use custom component lists, change to plain lists, add descriptions and links
-      for AIGNE Hub and Discuss Kit to help users understand these two products
-    createdAt: 2025-09-07T01:53:22.969Z
-    paths:
-      - /overview
-  - id: pref_4e8aa735b11d8484
-    active: true
-    scope: document
-    rule: In the 'How It Works' document, only show DocSmith implementation details, should not include AIGNE Framework
-      information.
-    feedback: How it works section does not need to show AIGNE Framework, only need to show DocSmith implementation
-    createdAt: 2025-09-06T13:15:10.272Z
-    paths:
-      - /advanced/how-it-works
-  - id: pref_4ad26164f1f4fbf6
-    active: true
-    scope: document
-    rule: When describing multi-language support features, must clearly state support for 12 languages and list two to three
-      mainstream languages as examples.
-    feedback: Multi-language support related features, clearly support 12 languages, no above statement, and give examples
-      of two or three mainstream languages
-    createdAt: 2025-09-06T12:55:42.678Z
-  - id: pref_c84baec514ca5c60
-    active: true
-    scope: document
-    rule: Core features list must describe product functionality characteristics, not promotional value or importance.
-    feedback: Core features list should describe DocSmith's functional characteristics, not describe product importance like
-      a promotional brochure
-    createdAt: 2025-09-06T12:47:46.583Z
-  - id: pref_6da200d8e6fec09e
-    active: true
-    scope: structure
-    rule: Do not generate documentation about contribution guidelines.
-    feedback: Remove contribution guidelines related documentation, this content is not ready yet
-    createdAt: 2025-08-30T14:46:32.741Z
-  - id: pref_8c619b5228f791e5
-    active: true
-    scope: document
-    rule: Do not generate content about Mermaid chart validation, as charts have been changed to use D2.
-    feedback: Remove mermaid chart validation related descriptions, charts now use D2
-    createdAt: 2025-08-30T14:29:04.068Z
-  - id: pref_0e154f58c22329fb
-    active: true
-    scope: document
-    rule: Do not generate documentation content about development commands that are no longer supported.
-    feedback: Remove development command related documentation, these development commands are no longer supported
-    createdAt: 2025-08-30T14:13:50.446Z
-  - id: pref_0112657e4103ba88
-    active: true
-    scope: structure
-    rule: Update documentation structure based on the latest source code, can add new documents and modify document
-      dependencies on source code, but prohibit modifying any existing document paths.
-    feedback: Update documentation structure based on the latest source code, allow adding new documents and modifying
-      document dependencies on source code, cannot modify existing document paths
-    createdAt: 2025-08-30T14:03:47.434Z