Skip to content

docs(character): 补充清理上下文说明#38

Merged
CookSleep merged 1 commit into
ChatLunaLab:mainfrom
CookSleep:docs/refine-guide-plugin-copy
Jun 5, 2026
Merged

docs(character): 补充清理上下文说明#38
CookSleep merged 1 commit into
ChatLunaLab:mainfrom
CookSleep:docs/refine-guide-plugin-copy

Conversation

@CookSleep
Copy link
Copy Markdown
Member

@CookSleep CookSleep commented Jun 5, 2026

概要

  • 补充默认预设可交给 AI 辅助改写的说明。
  • 补充 chatluna.character.clear 清理上下文命令的使用方式。
  • 微调 status 字段相关文案格式。

校验

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Enhanced Character plugin documentation with detailed explanations of preset fields (name, nick_name, input, system, status, mute_keyword)
    • Added command examples for clearing chat context across group chats, private chats, and default settings
    • Improved guidance on AI-generated and user-modified presets with step-by-step instructions

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Complex PR? Review this PR in Change Stack to move by importance, not file order.

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1a4635d2-b264-45bf-8a75-704e240d63b7

📥 Commits

Reviewing files that changed from the base of the PR and between c2a1c11 and d754974.

📒 Files selected for processing (1)
  • docs/ecosystem/other/character.md

📝 Walkthrough

Walkthrough

The Character plugin documentation for preset templates is updated with clearer guidance on using AI to generate or modify presets, command examples for clearing context history, and a restructured explanation of the six core preset configuration fields with expanded status field documentation.

Changes

Character Plugin Documentation

Layer / File(s) Summary
Preset Template Guidance and Field Structure
docs/ecosystem/other/character.md
Adds operation guidance for AI-assisted preset generation/modification, introduces chatluna.character.clear command examples for group chats and private chats, and restructures preset field explanations into six core fields with expanded status section introduction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ChatLunaLab/doc#21: Both PRs update the Character preset documentation, particularly the preset field explanations including status and mute_keyword.
  • ChatLunaLab/doc#23: Both PRs update Character preset template usage guidance and related documentation, with one expanding character.md field structure and the other synchronizing preset configuration.
  • ChatLunaLab/doc#35: Both PRs extend and adjust the Character preset template documentation in docs/ecosystem/other/character.md.

Suggested reviewers

  • dingyi222666

Poem

🐰 A preset guide blooms clear and bright,
Six fields now shine in guiding light!
With AI's help and context swept,
The Character paths are neatly kept.
Doc whispers true—update complete! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@CookSleep CookSleep merged commit 0c79d5b into ChatLunaLab:main Jun 5, 2026
1 check was pending
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the character documentation to include a tip on clearing session context using the chatluna.character.clear command, alongside minor formatting improvements. The review feedback suggests refining the phrasing for better readability and adding documentation for the default parameterless usage of the clear command.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.


**不同的预设中的指引有所不同,请仔细查看涉及到工具调用回复的部分,如 `chatluna-toolbox` 的配置说明。**

你可以将上方的默认预设中的一种(及你的旧预设)发送给 AI,让它在遵循默认预设格式的情况下,为你生成新的预设(或修改旧预设)。
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

“(及你的旧预设)”表述略显生硬,建议修改为“(以及你现有的旧预设)”或“(以及你的旧预设)”,使中文句子更加通顺、自然。

Suggested change
你可以将上方的默认预设中的一种(及你的旧预设)发送给 AI,让它在遵循默认预设格式的情况下,为你生成新的预设(或修改旧预设)。
你可以将上方的默认预设中的一种(以及你现有的旧预设)发送给 AI,让它在遵循默认预设格式的情况下,为你生成新的预设(或修改旧预设)。

Comment on lines +56 to +59
> 命令支持以下几种使用方式:
> - 清理指定群聊上下文:`chatluna.character.clear group:123` 或 `chatluna.character.clear g:123`
> - 清理指定私聊上下文:`chatluna.character.clear private:123` 或 `chatluna.character.clear p:123`
> - 未指定会话类型时,默认清理该 ID 的群聊上下文:`chatluna.character.clear 123`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

在实际使用中,用户最常用的操作通常是直接清理当前所在的会话上下文。建议在此处补充说明不带参数直接运行命令时的行为(即清理当前会话),以便用户更直观地了解最便捷的使用方式。\n\n例如可以修改为:\n\nmarkdown\n> 命令支持以下几种使用方式:\n> - 清理当前会话上下文:直接输入 `chatluna.character.clear`\n> - 清理指定群聊上下文:`chatluna.character.clear group:123` 或 `chatluna.character.clear g:123`\n> - 清理指定私聊上下文:`chatluna.character.clear private:123` 或 `chatluna.character.clear p:123`\n> - 未指定会话类型时,默认清理该 ID 的群聊上下文:`chatluna.character.clear 123`\n

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