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

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,28 +0,0 @@
-## Related Issue
-
-<!-- Use keywords like fixes, closes, resolves, relates to link the issue. In principle, all PRs should be associated with an issue -->
-
-### Major Changes
-
-<!--
-  @example:
-    1. Fixed xxx
-    2. Improved xxx
-    3. Adjusted xxx
--->
-
-### Screenshots
-
-<!-- If the changes are related to the UI, whether CLI or WEB, screenshots should be included -->
-
-### Test Plan
-
-<!-- If this change is not covered by automated tests, what is your test case collection? Please write it as a to-do list below -->
-
-### Checklist
-
-- [ ] This change requires documentation updates, and I have updated the relevant documentation. If the documentation has not been updated, please create a documentation update issue and link it here
-- [ ] The changes are already covered by tests, and I have adjusted the test coverage for the changed parts
-- [ ] The newly added code logic is also covered by tests
-- [ ] This change adds dependencies, and they are placed in dependencies and devDependencies
-- [ ] This change includes adding or updating npm dependencies, and it does not result in multiple versions of the same dependency [check the diff of pnpm-lock.yaml]

package/.github/workflows/ci.yml

@@ -1,54 +0,0 @@
-name: CI
-
-env:
-  NODE_OPTIONS: "--max_old_space_size=6144"
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  lint_and_test:
-    runs-on: ubuntu-latest
-
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-
-      - uses: pnpm/action-setup@v3
-        with:
-          version: 10
-
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 23
-          cache: pnpm
-
-      - name: Setup bun
-        uses: oven-sh/setup-bun@v2
-
-      - name: Install dependencies
-        run: |
-          pnpm install
-
-      - name: Lint
-        run: pnpm lint
-
-      - name: Test
-        run: pnpm test:coverage
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

package/.github/workflows/create-release-pr.yaml

@@ -1,21 +0,0 @@
-name: Create Release PR
-
-env:
-  NODE_OPTIONS: "--max_old_space_size=6144"
-
-on:
-  workflow_dispatch:
-
-permissions: 
-  contents: write
-  pull-requests: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: AIGNE-io/release-please-action@v4.3.0
-        id: release
-        with:
-          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
-          release-stable: true 

package/.github/workflows/publish-docs.yml

@@ -1,65 +0,0 @@
-name: publish docs
-
-env:
-  AIGNE_HUB_API_KEY: ${{ secrets.AIGNE_HUB_API_KEY }}
-
-permissions:
-  contents: write
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish-docs:
-    runs-on: ubuntu-latest
-    if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          ref: ${{ github.head_ref || github.ref_name }}
-          fetch-depth: 0
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22.16.0'
-
-      - uses: oven-sh/setup-bun@v2
-        with:
-          bun-version: latest
-
-      - name: Install @aigne/cli
-        run: |
-          bun install -g @aigne/cli@beta
-
-      - name: Publish docs to arcblock.io
-        env:
-          DOC_DISCUSS_KIT_ACCESS_TOKEN: ${{ secrets.DOC_PUBLISH_API_KEY_ARCBLOCK }}
-        run: |
-          set -e
-          aigne doc publish --appUrl https://www.arcblock.io
-
-      - name: Publish docs to docsmith
-        env:
-          DOC_DISCUSS_KIT_ACCESS_TOKEN: ${{ secrets.DOC_PUBLISH_API_KEY_DOCSMITH }}
-        run: |
-          set -e
-          aigne doc publish --appUrl https://docsmith.aigne.io
-
-      - name: Commit and push changes
-        run: |
-          git config --local user.name "bot"
-          git config --local user.email "bot@arcblock.io"
-          if [ -n "$(git status --porcelain)" ]; then
-            echo "Changes detected. Committing and pushing..."
-            git add -A
-            git commit -m "chore(docs): push doc publish cache [skip ci]"
-            BRANCH="${{ github.head_ref || github.ref_name }}"
-            git push origin HEAD:refs/heads/"${BRANCH}"
-          else
-            echo "No changes to commit."
-          fi

package/.github/workflows/release.yml

@@ -1,49 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - main
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: AIGNE-io/release-please-action@v4.3.0
-        id: release
-        with:
-          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
-
-      - name: Checkout
-        uses: actions/checkout@v4
-        if: ${{ steps.release.outputs.release_created }}
-        with:
-          fetch-depth: 2
-
-      - uses: pnpm/action-setup@v3
-        if: ${{ steps.release.outputs.release_created }}
-        with:
-          version: 10
-
-      - name: Setup node
-        uses: actions/setup-node@v4
-        if: ${{ steps.release.outputs.release_created }}
-        with:
-          node-version: 23
-          cache: pnpm
-
-      - name: Install dependencies
-        run: |
-          pnpm install
-        if: ${{ steps.release.outputs.release_created }}
-
-      - name: Publish to NPM
-        if: ${{ steps.release.outputs.release_created }}
-        run: |
-          npm config set '//registry.npmjs.org/:_authToken' "${{ secrets.NPM_TOKEN }}"
-          TAG=$(node -p "require(\"./package.json\").version.includes(\"beta\") ? \"beta\" : \"latest\"")
-          pnpm publish --access public --no-git-checks --tag $TAG || true

package/.github/workflows/reviewer.yml

@@ -1,54 +0,0 @@
-name: Code Review
-
-permissions:
-  contents: read
-  pull-requests: write
-
-on:
-  pull_request:
-    types: [opened]
-    branches:
-      - main
-
-concurrency:
-  group:
-    ${{ github.repository }}-${{ github.event.number || github.head_ref ||
-    github.sha }}-${{ github.workflow }}-${{ github.event_name ==
-    'pull_request_review_comment' && 'pr_comment' || 'pr' }}
-  cancel-in-progress: ${{ github.event_name != 'pull_request_review_comment' }}
-
-jobs:
-  review:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: aigne-io/aigne-code-smith@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          DEBUG: '@aigne/*'
-        with:
-          debug: false
-          language: 'en-US'
-          disable_review: false
-          review_simple_changes: false
-          review_comment_lgtm: false
-          suggest_pr_title: true
-          path_filters: |
-            !docs/*
-            !**/*.md
-            !**/package.json
-            !**/*.yaml
-          system_message: |
-            You are `@codesmith`, a highly experienced software engineer who provides a thorough review of the code hunks.
-            **CRITICAL REVIEW FOCUS**: Only post comments for CRITICAL issues that significantly impact code quality:
-              - Security vulnerabilities or potential exploits
-              - Logic errors that could cause bugs or incorrect behavior
-              - Performance issues that could impact system efficiency
-              - Error handling problems that could cause crashes or data loss
-              - **ALL language quality issues are considered CRITICAL**:
-                * Spelling errors in comments, strings, and documentation
-                * Grammar mistakes and awkward phrasing
-                * Unclear or confusing wording that may hinder understanding
-                * Variable/function names that could be more descriptive or follow better naming conventions
-                * Comment clarity and proper English usage
-            **STRICT FILTERING**: Do NOT comment on minor style preferences, formatting choices, css-in-js, typescript importing, or subjective improvements unless they fall into the CRITICAL categories above.

package/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.8.12-beta.8"
-}

package/RELEASE.md

@@ -1,9 +0,0 @@
-### Release a beta version
-
-Create a normal PR, and release-please will automatically create a beta version PR.  
-Merge that PR when appropriate.
-
-### Release a prod version
-
-When you want publish a prod version, manually execute the GitHub Action 'Create Release PR' to create a release PR for the prod version.
-Merge that PR when appropriate.

package/biome.json

@@ -1,73 +0,0 @@
-{
-  "$schema": "https://biomejs.dev/schemas/2.2.4/schema.json",
-  "vcs": {
-    "enabled": true,
-    "clientKind": "git",
-    "useIgnoreFile": true
-  },
-  "files": {
-    "ignoreUnknown": true,
-    "experimentalScannerIgnores": ["node_modules"]
-  },
-  "formatter": {
-    "enabled": true,
-    "indentStyle": "space",
-    "lineWidth": 100
-  },
-  "linter": {
-    "enabled": true,
-    "rules": {
-      "recommended": true,
-      "correctness": {
-        "useImportExtensions": "error",
-        "noUnusedVariables": "error",
-        "noUnusedImports": "error",
-        "noUnusedFunctionParameters": "error",
-        "noUnusedPrivateClassMembers": "error",
-        "noUndeclaredVariables": "error",
-        "noUnreachable": "error",
-        "noSelfAssign": "error"
-      },
-      "suspicious": {
-        "noConfusingVoidType": "off",
-        "noExplicitAny": "off",
-        "noDoubleEquals": "error",
-        "noGlobalAssign": "error",
-        "noAssignInExpressions": "warn"
-      },
-      "style": {
-        "useNodejsImportProtocol": "error",
-        "useTemplate": "error"
-      },
-      "complexity": {
-        "noForEach": "off",
-        "useLiteralKeys": "off"
-      }
-    }
-  },
-  "javascript": {
-    "formatter": {
-      "quoteStyle": "double"
-    }
-  },
-  "assist": {
-    "enabled": true,
-    "actions": {
-      "source": {
-        "organizeImports": "on"
-      }
-    }
-  },
-  "overrides": [
-    {
-      "includes": ["**/fixtures/**", ".aigne/doc-smith/output/structure-plan.json"],
-
-      "linter": {
-        "enabled": false
-      },
-      "formatter": {
-        "enabled": false
-      }
-    }
-  ]
-}

package/codecov.yml

@@ -1,15 +0,0 @@
-coverage:
-  status:
-    project: #add everything under here, more options at https://docs.codecov.com/docs/commit-status
-      default:
-        # basic
-        target: auto #default
-        threshold: 0%
-        base: auto 
-comment:
-  layout: "header, changes, diff, flags, files"
-  behavior: default
-  require_changes: false
-  require_base: false
-  require_head: true
-  hide_project_coverage: false

package/docs/_sidebar.md

@@ -1,15 +0,0 @@
-* [Overview](/overview.md)
-* [Getting Started](/getting-started.md)
-* [Guides](/guides.md)
-  * [Generating Documentation](/guides-generating-documentation.md)
-  * [Updating Documentation](/guides-updating-documentation.md)
-  * [Translating Documentation](/guides-translating-documentation.md)
-  * [Publishing Your Docs](/guides-publishing-your-docs.md)
-  * [Managing History](/guides-managing-history.md)
-  * [Evaluating Documents](/guides-evaluating-documents.md)
-  * [Cleaning Up](/guides-cleaning-up.md)
-  * [Interactive Chat](/guides-interactive-chat.md)
-* [Configuration](/configuration.md)
-  * [Initial Setup](/configuration-initial-setup.md)
-  * [Managing Preferences](/configuration-managing-preferences.md)
-* [Release Notes](/release-notes.md)

package/docs/configuration-initial-setup.ja.md

@@ -1,179 +0,0 @@
-# 初期設定
-
-このガイドでは、AIGNE DocSmith の対話型セットアッププロセスをステップバイステップで説明します。このプロセスは、`generate` コマンドを初めて実行する際に開始されるか、手動で開始することもできます。その目的は、ドキュメント生成の設定を保存する `config.yaml` ファイルを作成することです。
-
-## プロセスの開始
-
-設定を手動で開始するには、ターミナルでプロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
-
-```bash
-aigne doc init
-```
-
-このコマンドは対話式の質問を起動し、ドキュメント設定の構成をガイドします。
-
-## 設定手順
-
-セットアッププロセスは、特定のニーズに合わせてドキュメントを調整するために設計された 9 つの質問で構成されています。
-
-### ステップ 1: ドキュメントの目的を定義する
-
-最初に、ドキュメントの主な目的を定義するよう求められます。この選択は、生成されるコンテンツのトーン、構造、および焦点に影響を与えます。
-
-**プロンプト:** `📝 [1/9]: What should your documentation help readers achieve?`
-
-以下のリストから複数のオプションを選択できます。
-
-| オプション | 名前 | 説明 |
-| :--- | :--- | :--- |
-| `getStarted` | 迅速な利用開始 | 新規ユーザーが 30 分以内にゼロから作業を開始できるよう支援します。 |
-| `completeTasks` | 特定のタスクの完了 | 一般的なワークフローとユースケースをユーザーに案内します。 |
-| `findAnswers` | 迅速な回答の検索 | すべての機能と API の検索可能なリファレンスを提供します。 |
-| `understandSystem` | システムの理解 | システムの仕組みと設計決定の背後にある理由を説明します。 |
-| `solveProblems` | 問題の解決 | ユーザーが問題をトラブルシューティングし、修正するのを助けます。 |
-| `mixedPurpose` | 上記の組み合わせ | 複数のニーズを包括的にカバーします。 |
-
-### ステップ 2: 対象読者を特定する
-
-次に、ドキュメントの主な読者を指定します。これにより、言語と技術的な深さを適切に調整できます。
-
-**プロンプト:** `👥 [2/9]: Who will be reading your documentation?`
-
-以下の読者から 1 つ以上を選択できます。
-
-| オプション | 名前 | 説明 |
-| :--- | :--- | :--- |
-| `endUsers` | エンドユーザー (非技術者) | 製品を使用するがコーディングはしない人々。 |
-| `developers` | 統合開発者 | これを自分のプロジェクトに追加するエンジニア。 |
-| `devops` | DevOps/インフラストラクチャ | システムをデプロイ、監視、保守するチーム。 |
-| `decisionMakers` | 技術的な意思決定者 | テクノロジーを評価するアーキテクトやリード。 |
-| `supportTeams` | サポートチーム | 他の人が製品を使用するのを助ける人々。 |
-| `mixedTechnical` | 混合技術読者層 | 開発者、DevOps、その他の技術ユーザーの組み合わせ。 |
-
-### ステップ 3: カスタムルールを提供する
-
-このオプションのステップでは、コンテンツ生成中に AI が従うべき特定の指示や制約を提供できます。
-
-**プロンプト:** `📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
-
-トーン、スタイル、除外するコンテンツなど、特定の要件を入力できます。例: 「マーケティング用語の使用を避け、技術的な正確さに焦点を当てる。」
-
-### ステップ 4: 読者の知識レベルを指定する
-
-読者の想定される知識レベルを示してください。これにより、コンテンツが簡単すぎず、複雑すぎず、適切なレベルで提供されることが保証されます。
-
-**プロンプト:** `🧠 [4/9]: How much do readers already know about your project?`
-
-読者に最も合うオプションを選択してください。
-
-| オプション | 名前 | 説明 |
-| :--- | :--- | :--- |
-| `completeBeginners` | 完全な初心者 | ドメインやテクノロジーに全く慣れていない。 |
-| `domainFamiliar` | ドメインには詳しいが、ツールは初めて | 問題領域は知っているが、このソリューションは初めて。 |
-| `experiencedUsers` | 経験豊富なユーザー | リファレンスや高度なトピックを必要とする通常のユーザー。 |
-| `emergencyTroubleshooting` | 緊急/トラブルシューティング | 問題を迅速に解決する必要があるユーザー。 |
-| `exploringEvaluating` | 探索/評価中 | ツールが自分のニーズに合うかどうかを判断しようとしているユーザー。 |
-
-### ステップ 5: ドキュメントの深さを設定する
-
-ドキュメントをどれだけ詳細にするかを選択します。これにより、生成されるコンテンツの範囲と詳細レベルが決まります。
-
-**プロンプト:** `📊 [5/9]: How detailed should your documentation be?`
-
-以下の詳細レベルから 1 つを選択してください。
-
-| オプション | 名前 | 説明 |
-| :--- | :--- | :--- |
-| `essentialOnly` | 不可欠なもののみ | 最も一般的な 80% のユースケースを簡潔にカバーします。 |
-| `balancedCoverage` | バランスの取れたカバレッジ | 実用的な例とともに十分な深さを提供します。 |
-| `comprehensive` | 包括的 | すべての機能、エッジケース、高度なシナリオをカバーします。 |
-| `aiDecide` | AI に決定させる | ツールがコードの複雑さを分析し、適切な深さを提案します。 |
-
-### ステップ 6: 主要言語を選択する
-
-ドキュメントの主要言語を選択します。システムはオペレーティングシステムの言語を検出し、デフォルトとして提案します。
-
-**プロンプト:** `🌐 [6/9]: What's your main documentation language?`
-
-英語、中国語 (簡体字)、スペイン語を含む 12 のサポートされている言語のリストが表示されます。
-
-### ステップ 7: 翻訳言語を選択する
-
-ドキュメントを翻訳したい追加の言語を選択します。
-
-**プロンプト:** `🔄 [7/9]: Which languages should we translate to?`
-
-前のステップで選択した主要言語を除き、サポートされているオプションのリストから複数の言語を選択できます。
-
-### ステップ 8: 出力ディレクトリを定義する
-
-生成されたドキュメントファイルを保存するフォルダを指定します。
-
-**プロンプト:** `📁 [8/9]: Where should we save your documentation?`
-
-デフォルトのパスは `.aigne/doc-smith/docs` です。これを受け入れるか、別のパスを提供することができます。
-
-### ステップ 9: コンテンツソースを指定する
-
-ドキュメントを生成するためにツールが分析すべきファイルとフォルダを指定します。複数のパスを追加したり、高度なフィルタリングのために glob パターンを使用したりできます。
-
-**プロンプト:** `🔍 [9/9]: Content Sources`
-
-ファイルパス、フォルダパス、または glob パターン (例: `src/**/*.js`) を入力するよう求められます。パスを指定しない場合、ツールはデフォルトでプロジェクトディレクトリ全体を分析します。
-
-## 生成された設定ファイル
-
-質問に回答し終えると、DocSmith はあなたの回答を `.aigne/doc-smith/` ディレクトリにある `config.yaml` という名前の設定ファイルに保存します。このファイルは、将来のすべてのドキュメント生成の設計図として機能し、いつでも手動で編集できます。
-
-以下は、生成された `config.yaml` ファイルの例です。
-
-```yaml config.yaml title="config.yaml"
-# ドキュメント公開用のプロジェクト情報
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# ドキュメント設定
-# =============================================================================
-
-# 目的: 読者に達成してほしい主な成果は何か？
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 対象読者: 誰がこれを最も頻繁に読むか？
-targetAudienceTypes:
-  - endUsers
-
-# 読者の知識レベル: 読者は通常、どのような知識を持っているか？
-readerKnowledgeLevel: completeBeginners
-
-# ドキュメントの深さ: ドキュメントはどの程度包括的であるべきか？
-documentationDepth: comprehensive
-
-# カスタムルール: 特定のドキュメント生成ルールと要件を定義する
-rules: |
-  Avoid using vague or empty words...
-
-# 対象読者: 特定の対象読者とその特徴を記述する
-targetAudience: |
-  
-# 言語設定
-locale: en
-translateLanguages:
-  - zh
-  - ja
-
-# ディレクトリとソースパスの設定
-docsDir: ./docs  # 生成されたドキュメントを保存するディレクトリ
-sourcesPath:  # 分析するソースコードのパス
-  - ./README.md
-  - ./agents
-```
-
-## 次のステップ
-
-初期設定が完了し、ドキュメントを作成する準備が整いました。
-
-*   [ドキュメントの生成](./guides-generating-documentation.md) ガイドに進み、生成プロセスの実行方法を学びましょう。