Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: pin #70

Merged
merged 1 commit into from
Feb 16, 2025
Merged

docs: pin #70

merged 1 commit into from
Feb 16, 2025

Conversation

yenche123
Copy link
Owner

@yenche123 yenche123 commented Feb 16, 2025

Summary by CodeRabbit

  • 新功能
    • 为用户新增了多个资源入口,包括使用指南、客服联系、个人日程、收藏、看板、标签及开源仓库链接。
  • 风格优化
    • 调整了登录指引和客服回复中的文本描述,使语言表述更为清晰统一。
  • 文档更新
    • 添加了“置顶”说明,指导用户如何将服务账号置顶与管理消息提醒,提升使用便捷性。

Copy link

coderabbitai bot commented Feb 16, 2025

Walkthrough

本次 PR 对后端云函数和文档进行了文本内容更新。在 ai-prompt.ts 中新增了多个指引、联系和个性化界面链接;在 common-i18n.ts 中对部分中文提示文案做了细微调整;同时在文档中添加了“置顶”部分,为用户提供服务号置顶和消息免打扰的操作说明。所有改动均为静态文本和链接更新,未修改导出实体声明。

Changes

文件 变更摘要
liubai-backends/.../cloud-functions/ai-prompt.ts
liubai-backends/.../cloud-functions/common-i18n.ts
更新微信系统入口常量和语言提示,新增使用指南、客户服务、日程、收藏、看板、标签链接;对“login_guide”文案和客户服务回复文字进行细微修正。
liubai-docs/.../guide/three-assistants.md 新增“置顶”部分,提供服务号置顶及消息免打扰设置说明。

Possibly related PRs

  • fix: prompt about tool use #50: 修改 ai-prompt.ts 中 bot 优先级属性,与本次新增入口链接直接相关。
  • fix: breakpoint of summary #42: 对 ai-prompt.tsaiBots 数组的 metaData 属性做了调整,直接关联到入口常量的修改。
  • chore: LLM #67: 调整 ai-prompt.ts 文件中 priority 值,与本次对 system_wx_entry 的更新存在直接联系。

Poem

我是跳跃的小兔子,代码森林真奇妙,
链接纷呈如星光,指引路途步步高,
文案细微添色彩,服务贴心亮眼眸,
置顶指南轻揭秘,免打扰的秘诀绕,
改动虽小心意浓,祝福代码遍天骄! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
liubai-docs/docs/guide/three-assistants.md (1)

69-69: 建议添加图片的替代文本。

为了提高文档的可访问性,建议为图片添加描述性的 alt 文本。

-<img src="./assets-three-assistants/pin-liubai.png" width="400">
+<img src="./assets-three-assistants/pin-liubai.png" width="400" alt="在微信中置顶留白记事的操作步骤">
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

69-69: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f37be31 and fffe8c8.

⛔ Files ignored due to path filters (1)
  • liubai-docs/docs/guide/assets-three-assistants/pin-liubai.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • liubai-backends/liubai-laf/cloud-functions/ai-prompt.ts (1 hunks)
  • liubai-backends/liubai-laf/cloud-functions/common-i18n.ts (3 hunks)
  • liubai-docs/docs/guide/three-assistants.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
liubai-docs/docs/guide/three-assistants.md

69-69: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

🔇 Additional comments (3)
liubai-backends/liubai-laf/cloud-functions/ai-prompt.ts (1)

280-288: 很好的改进!

新增的链接为用户提供了清晰的导航路径,涵盖了使用指南、客服支持、个人中心等关键功能。这些链接的组织结构合理,有助于提升用户体验。

liubai-backends/liubai-laf/cloud-functions/common-i18n.ts (1)

244-244: 文案优化得很好!

将"注意现在"改为"当前"更加准确和专业,同时在简体中文和繁体中文中保持了一致性。

Also applies to: 257-257

liubai-docs/docs/guide/three-assistants.md (1)

65-74: 内容补充得很好!

新增的置顶部分为用户提供了实用的操作指引,同时关联了避免漏接提醒的说明,对提升用户体验很有帮助。

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

69-69: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

@yenche123 yenche123 merged commit 4187b27 into cool Feb 16, 2025
1 check passed
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