@aigne/doc-smith 0.8.12-beta.8 → 0.8.12

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