Skip to content

docs: add tools doc - #17

Merged
hexqi merged 1 commit into
developfrom
docs/tools
Apr 18, 2025
Merged

docs: add tools doc#17
hexqi merged 1 commit into
developfrom
docs/tools

Conversation

@hexqi

@hexqi hexqi commented Apr 18, 2025

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features
    • Added a new "工具" (Tools) section to the navigation menu and sidebar in the documentation.
    • Introduced documentation for the AI interaction client, including usage examples for synchronous and streaming chat.
    • Added documentation for message and data management utilities, detailing API options, state management, and usage patterns.

@coderabbitai

coderabbitai Bot commented Apr 18, 2025

Copy link
Copy Markdown

Walkthrough

The changes introduce new documentation and configuration for a set of AI tools within a documentation site. The navigation and sidebar are updated to include a "工具" (Tools) section, with entries for "AI模型交互工具类" (AI Model Interaction Utility) and "消息与数据管理" (Message and Data Management). Two new documentation files are added: one detailing the AIClient class for interacting with AI models, and another describing the useMessage composable for managing chat messages and their state. No modifications were made to existing navigation or exported entities.

Changes

File(s) Change Summary
packages/docs/.vitepress/config.mts Added a "工具" (Tools) entry to the top-level navigation linking to /tools/ai-client, with a new sidebar section for /tools/ containing links to "AI模型交互工具类" (ai-client) and "消息与数据管理" (message). No existing entries were altered or removed.
packages/docs/src/tools/ai-client.md New documentation describing the AIClient class, its constructor, methods for chat and streaming chat interactions, and usage examples for both synchronous and streaming requests, including error handling and streaming event callbacks.
packages/docs/src/tools/message.md New documentation for the useMessage composable, detailing its options, return interface, state management, status enum, and methods for handling chat messages, request lifecycle, and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant AIClient
    participant AI Model

    User ->> DocsSite: Navigates to /tools/ai-client
    DocsSite ->> User: Displays AIClient documentation

    User ->> DocsSite: Navigates to /tools/message
    DocsSite ->> User: Displays useMessage documentation

    User ->> AIClient: chat(request)
    AIClient ->> AI Model: Sends chat request
    AI Model -->> AIClient: Returns response
    AIClient -->> User: Returns ChatCompletionResponse

    User ->> AIClient: chatStream(request, handler)
    AIClient ->> AI Model: Sends streaming chat request
    AI Model -->> AIClient: Streams data chunks
    AIClient -->> User: Calls handler.onData/onDone/onError
Loading

Poem

In the warren of docs, new tools appear,
For chatting with models, the guidance is clear.
With AIClient’s wisdom and messages in tow,
Rabbits send queries and watch answers flow.
Sidebars are hopping with links shiny and new,
A burrow of knowledge for me and for you!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 35476fa and faa55a5.

📒 Files selected for processing (3)
  • packages/docs/.vitepress/config.mts (2 hunks)
  • packages/docs/src/tools/ai-client.md (1 hunks)
  • packages/docs/src/tools/message.md (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@hexqi
hexqi merged commit 74905a8 into develop Apr 18, 2025
@hexqi
hexqi deleted the docs/tools branch July 4, 2025 02:07
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