Skip to content

docs: cleanup outdated documentation and configuration#315

Merged
ModerRAS merged 2 commits intomasterfrom
cleanup-outdated
Apr 25, 2026
Merged

docs: cleanup outdated documentation and configuration#315
ModerRAS merged 2 commits intomasterfrom
cleanup-outdated

Conversation

@ModerRAS
Copy link
Copy Markdown
Owner

@ModerRAS ModerRAS commented Apr 24, 2026

Summary

Cleanup of outdated documentation and configuration in the project.

Changes

  • Remove obsolete Qdrant vector search documentation
  • Update vector command names: /向量* to /faiss*
  • Update LiteDB reference to SQLite
  • Remove completed Qdrant migration instructions
  • Update .NET version: 8.0 to 10.0
  • Update MCP attribute examples: [McpTool] to [BuiltInTool]
  • Remove personal HTTP_PROXY from launchSettings.json

Verification

  • dotnet build --configuration Release: Passed
  • All outdated command/API references updated

Summary by CodeRabbit

  • Documentation

    • Revised AI assistant tool-discovery instructions and expanded built-in tool registry.
    • Expanded and reorganized administrator and admin-only command guides (new FAISS/vector, scheduler, agent, accounting, file/media, and management commands); removed some prior tool mentions and vendor-specific vector-db guidance; deleted an outdated vector-search guide.
    • Standardized command names and pagination/cache documentation.
  • Chores

    • Updated local run configuration and test framework runtime declaration.

- Remove obsolete Qdrant vector search documentation (README_VectorSearch.md)
- Update vector command names: /向量* → /faiss*
- Update LiteDB reference to SQLite in Bot_Commands_User_Guide.md
- Remove completed Qdrant migration instructions from README_FaissVectorSearch.md
- Update .NET version in Vector/README.md: 8.0 → 10.0
- Update MCP attribute examples in copilot-instructions.md: [McpTool] → [BuiltInTool]
- Remove personal HTTP_PROXY from launchSettings.json
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

📝 Walkthrough

Walkthrough

Updates documentation and a local launch configuration: renames MCP tool annotations to [BuiltInTool]/[BuiltInParameter], consolidates vector-search docs around FAISS (removes Qdrant content and one VectorSearch doc), changes pagination cache reference from LiteDB to SQLite, and removes an HTTP_PROXY launch var.

Changes

Cohort / File(s) Summary
Tool convention docs
/.github/copilot-instructions.md
Rename referenced MCP attributes to [BuiltInTool] and [BuiltInParameter] in Copilot guidance.
User/admin command docs
Docs/Bot_Commands_User_Guide.md
Switches documented search pagination cache from LiteDB (CacheData) to SQLite (SearchPageCaches); adds/updates numerous user/admin command sections (FAISS/vector, Lucene syntax, admin tooling, accounting, media scanning).
FAISS / vector search docs
Docs/README_FaissVectorSearch.md, Docs/README_VectorDatabaseInit.md, Docs/README_VectorSearch.md
Generalize FAISS guidance, remove Qdrant migration/comparison material, rename vector init commands to faiss..., and delete the README_VectorSearch.md file.
MCP registry / tools docs
Docs/README_MCP.md
Expand built-in tool list, remove EditFile, add send_message, and rewrite many tool parameter schemas and admin tool descriptions.
Dev/test metadata & config
TelegramSearchBot.Test/Service/Vector/README.md, TelegramSearchBot/Properties/launchSettings.json
Bump test README runtime metadata to .NET 10.0; remove HTTP_PROXY env var from launch settings.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with nimble paws,
Swapped names and trimmed redundant clause.
FAISS now sings, Qdrant steps aside,
SQLite caches page turns with pride.
thump-thump, happy bunny hops 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: cleanup outdated documentation and configuration' accurately describes the primary change—removing obsolete documentation (Qdrant), updating outdated command references, and removing stale configuration entries across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cleanup-outdated

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

🔍 PR检查报告

📋 检查概览

🧪 测试结果

平台 状态 详情
Ubuntu 🟢 成功 测试通过,产物已上传
Windows 🟢 成功 测试通过,产物已上传

📊 代码质量

  • ✅ 代码格式化检查
  • ✅ 安全漏洞扫描
  • ✅ 依赖包分析
  • ✅ 代码覆盖率收集

📁 测试产物

  • 测试结果 artifacts 数量: 2
  • 代码覆盖率已上传到Codecov

🔗 相关链接


此报告由GitHub Actions自动生成

- Add missing commands to Bot_Commands_User_Guide.md:
  - 向量搜索、语法搜索
  - 群组黑名单管理 (查黑名单/封群/解封群)
  - 定时任务管理 (/scheduler)
  - LLM Agent 管理 (/agent)
  - 系统更新 (/checkupdate, /update)
  - 测试定时任务
  - 交互式模型选择
  - 向量数据管理命令
  - 账本功能命令
- Fix README_MCP.md:
  - Remove non-existent EditFile tool
  - Fix tool names (memory_search→process_memory_command, brave_web_search→search_web)
  - Add missing tools (echo, calculator, send_message, execute_js, todo tools)
  - Update tool count from 24+ to 30+
  - Add complete parameter descriptions
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
Docs/README_MCP.md (1)

168-168: ⚠️ Potential issue | 🟡 Minor

Remove outdated EditFile reference.

The security section lists EditFile among admin-only file operation tools, but EditFile has been removed from the main tool registry table (lines 36-41) and is also absent from Docs/Bot_Commands_User_Guide.md line 358. For consistency with the cleanup performed elsewhere in this PR, the EditFile reference should be removed from this security note.

📝 Proposed fix
-以下工具仅对管理员开放:
-- 所有文件操作工具 (`ReadFile`, `WriteFile`, `EditFile`, `SearchText`, `ListFiles`)
+以下工具仅对管理员开放:
+- 所有文件操作工具 (`ReadFile`, `WriteFile`, `SearchText`, `ListFiles`)
 - MCP 服务器管理工具 (`AddMcpServer`, `RemoveMcpServer`, `UpdateMcpServer`, `RestartMcpServers`)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@Docs/README_MCP.md` at line 168, The security note still lists the removed
tool EditFile; update the line that enumerates admin-only file-operation tools
to remove EditFile so it only lists the current functions (ReadFile, WriteFile,
SearchText, ListFiles), and verify there are no other leftover mentions of
EditFile in this file (README_MCP.md) to keep the documentation consistent with
the main tool registry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@Docs/README_MCP.md`:
- Line 168: The security note still lists the removed tool EditFile; update the
line that enumerates admin-only file-operation tools to remove EditFile so it
only lists the current functions (ReadFile, WriteFile, SearchText, ListFiles),
and verify there are no other leftover mentions of EditFile in this file
(README_MCP.md) to keep the documentation consistent with the main tool
registry.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa3d8e44-5424-41d0-a815-3cac6e5e3319

📥 Commits

Reviewing files that changed from the base of the PR and between b129b50 and 25a0275.

📒 Files selected for processing (2)
  • Docs/Bot_Commands_User_Guide.md
  • Docs/README_MCP.md

@ModerRAS ModerRAS merged commit a584537 into master Apr 25, 2026
6 checks passed
@ModerRAS ModerRAS deleted the cleanup-outdated branch April 25, 2026 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant